ListBackupOperationsRequest (Google Cloud Spanner Parent 6.25.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.spanner.admin.database.v1.ListBackupOperationsRequest

All Implemented Interfaces:: Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ListBackupOperationsRequestOrBuilder, Serializable

public final class ListBackupOperationsRequest
extends GeneratedMessageV3
implements ListBackupOperationsRequestOrBuilder

 The request for
 [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

Protobuf type google.spanner.admin.database.v1.ListBackupOperationsRequest

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListBackupOperationsRequest.Builder` The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field and Description

static int FILTER_FIELD_NUMBER

static int PAGE_SIZE_FIELD_NUMBER

static int PAGE_TOKEN_FIELD_NUMBER

static int PARENT_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Fields
Modifier and Type	Field and Description
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`PAGE_SIZE_FIELD_NUMBER`
`static int`	`PAGE_TOKEN_FIELD_NUMBER`
`static int`	`PARENT_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static ListBackupOperationsRequest`	`getDefaultInstance()`
`ListBackupOperationsRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`String`	`getFilter()` An expression that filters the list of returned backup operations.
`ByteString`	`getFilterBytes()` An expression that filters the list of returned backup operations.
`int`	`getPageSize()` Number of operations to be returned in the response.
`String`	`getPageToken()` If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the same `parent` and with the same `filter`.
`ByteString`	`getPageTokenBytes()` If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token] from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the same `parent` and with the same `filter`.
`String`	`getParent()` Required.
`ByteString`	`getParentBytes()` Required.
`Parser<ListBackupOperationsRequest>`	`getParserForType()`
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static ListBackupOperationsRequest.Builder`	`newBuilder()`
`static ListBackupOperationsRequest.Builder`	`newBuilder(ListBackupOperationsRequest prototype)`
`ListBackupOperationsRequest.Builder`	`newBuilderForType()`
`protected ListBackupOperationsRequest.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ListBackupOperationsRequest`	`parseDelimitedFrom(InputStream input)`
`static ListBackupOperationsRequest`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static ListBackupOperationsRequest`	`parseFrom(byte[] data)`
`static ListBackupOperationsRequest`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static ListBackupOperationsRequest`	`parseFrom(ByteBuffer data)`
`static ListBackupOperationsRequest`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static ListBackupOperationsRequest`	`parseFrom(ByteString data)`
`static ListBackupOperationsRequest`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static ListBackupOperationsRequest`	`parseFrom(CodedInputStream input)`
`static ListBackupOperationsRequest`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static ListBackupOperationsRequest`	`parseFrom(InputStream input)`
`static ListBackupOperationsRequest`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<ListBackupOperationsRequest>`	`parser()`
`ListBackupOperationsRequest.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PARENT_FIELD_NUMBER
```
public static final int PARENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_SIZE_FIELD_NUMBER
```
public static final int PAGE_SIZE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_TOKEN_FIELD_NUMBER
```
public static final int PAGE_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getParent
```
public String getParent()
```
```
 Required. The instance of the backup operations. Values are of
 the form `projects/<project>/instances/<instance>`.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParent in interface ListBackupOperationsRequestOrBuilder

Returns:

The parent.

getParentBytes
```
public ByteString getParentBytes()
```
```
 Required. The instance of the backup operations. Values are of
 the form `projects/<project>/instances/<instance>`.
 
```
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Specified by:

getParentBytes in interface ListBackupOperationsRequestOrBuilder

Returns:

The bytes for parent.

getFilter

public String getFilter()

 An expression that filters the list of returned backup operations.
 A filter expression consists of a field name, a
 comparison operator, and a value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.
 The following fields in the [operation][google.longrunning.Operation]
 are eligible for filtering:
   * `name` - The name of the long-running operation
   * `done` - False if the operation is in progress, else true.
   * `metadata.@type` - the type of metadata. For example, the type string
      for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
      `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
   * `metadata.<field_name>` - any field in metadata.value.
      `metadata.@type` must be specified first if filtering on metadata
      fields.
   * `error` - Error associated with the long-running operation.
   * `response.@type` - the type of response.
   * `response.<field_name>` - any field in response.value.
 You can combine multiple expressions by enclosing each expression in
 parentheses. By default, expressions are combined with AND logic, but
 you can specify AND, OR, and NOT logic explicitly.
 Here are a few examples:
   * `done:true` - The operation is complete.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
      `metadata.database:prod` - Returns operations where:
      * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
      * The database the backup was taken from has a name containing the
      string "prod".
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.name:howl) AND` \
     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
     * The backup name contains the string "howl".
     * The operation started before 2018-03-28T14:50:00Z.
     * The operation resulted in an error.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
     `(metadata.source_backup:test) AND` \
     `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
     * The source backup of the copied backup name contains the string
     "test".
     * The operation started before 2022-01-18T14:50:00Z.
     * The operation resulted in an error.
   * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.database:test_db)) OR` \
     `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
     AND` \
     `(metadata.source_backup:test_bkp)) AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata matches either of criteria:
       * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the
       database the backup was taken from has name containing string
       "test_db"
       * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the
       backup the backup was copied from has name containing string
       "test_bkp"
     * The operation resulted in an error.

string filter = 2;

Specified by:: getFilter in interface ListBackupOperationsRequestOrBuilder
Returns:: The filter.

getFilterBytes

public ByteString getFilterBytes()

 An expression that filters the list of returned backup operations.
 A filter expression consists of a field name, a
 comparison operator, and a value for filtering.
 The value must be a string, a number, or a boolean. The comparison operator
 must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
 Colon `:` is the contains operator. Filter rules are not case sensitive.
 The following fields in the [operation][google.longrunning.Operation]
 are eligible for filtering:
   * `name` - The name of the long-running operation
   * `done` - False if the operation is in progress, else true.
   * `metadata.@type` - the type of metadata. For example, the type string
      for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
      `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
   * `metadata.<field_name>` - any field in metadata.value.
      `metadata.@type` must be specified first if filtering on metadata
      fields.
   * `error` - Error associated with the long-running operation.
   * `response.@type` - the type of response.
   * `response.<field_name>` - any field in response.value.
 You can combine multiple expressions by enclosing each expression in
 parentheses. By default, expressions are combined with AND logic, but
 you can specify AND, OR, and NOT logic explicitly.
 Here are a few examples:
   * `done:true` - The operation is complete.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
      `metadata.database:prod` - Returns operations where:
      * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
      * The database the backup was taken from has a name containing the
      string "prod".
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.name:howl) AND` \
     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
     * The backup name contains the string "howl".
     * The operation started before 2018-03-28T14:50:00Z.
     * The operation resulted in an error.
   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND` \
     `(metadata.source_backup:test) AND` \
     `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata].
     * The source backup of the copied backup name contains the string
     "test".
     * The operation started before 2022-01-18T14:50:00Z.
     * The operation resulted in an error.
   * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
     `(metadata.database:test_db)) OR` \
     `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata)
     AND` \
     `(metadata.source_backup:test_bkp)) AND` \
     `(error:*)` - Returns operations where:
     * The operation's metadata matches either of criteria:
       * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] AND the
       database the backup was taken from has name containing string
       "test_db"
       * The operation's metadata type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata] AND the
       backup the backup was copied from has name containing string
       "test_bkp"
     * The operation resulted in an error.

string filter = 2;

Specified by:: getFilterBytes in interface ListBackupOperationsRequestOrBuilder
Returns:: The bytes for filter.

getPageSize

public int getPageSize()

 Number of operations to be returned in the response. If 0 or
 less, defaults to the server's maximum allowed page size.

int32 page_size = 3;

Specified by:: getPageSize in interface ListBackupOperationsRequestOrBuilder
Returns:: The pageSize.

getPageToken

public String getPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token]
 from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the
 same `parent` and with the same `filter`.

string page_token = 4;

Specified by:: getPageToken in interface ListBackupOperationsRequestOrBuilder
Returns:: The pageToken.

getPageTokenBytes

public ByteString getPageTokenBytes()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token]
 from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the
 same `parent` and with the same `filter`.

string page_token = 4;

Specified by:: getPageTokenBytes in interface ListBackupOperationsRequestOrBuilder
Returns:: The bytes for pageToken.

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo
```
public void writeTo(CodedOutputStream output)
             throws IOException
```
Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize
```
public int getSerializedSize()
```
Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals
```
public boolean equals(Object obj)
```
Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode
```
public int hashCode()
```
Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListBackupOperationsRequest parseFrom(ByteBuffer data)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(ByteBuffer data,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(ByteString data)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(ByteString data,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(byte[] data)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(byte[] data,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws InvalidProtocolBufferException

Throws:: InvalidProtocolBufferException

parseFrom

public static ListBackupOperationsRequest parseFrom(InputStream input)
                                             throws IOException

Throws:: IOException

parseFrom

public static ListBackupOperationsRequest parseFrom(InputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:: IOException

parseDelimitedFrom

public static ListBackupOperationsRequest parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:: IOException

parseDelimitedFrom

public static ListBackupOperationsRequest parseDelimitedFrom(InputStream input,
                                                             ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:: IOException

parseFrom

public static ListBackupOperationsRequest parseFrom(CodedInputStream input)
                                             throws IOException

Throws:: IOException

parseFrom

public static ListBackupOperationsRequest parseFrom(CodedInputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:: IOException

newBuilderForType
```
public ListBackupOperationsRequest.Builder newBuilderForType()
```
Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListBackupOperationsRequest.Builder newBuilder()

newBuilder

public static ListBackupOperationsRequest.Builder newBuilder(ListBackupOperationsRequest prototype)

toBuilder
```
public ListBackupOperationsRequest.Builder toBuilder()
```
Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListBackupOperationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:: newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListBackupOperationsRequest getDefaultInstance()

parser

public static Parser<ListBackupOperationsRequest> parser()

getParserForType
```
public Parser<ListBackupOperationsRequest> getParserForType()
```
Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType
```
public ListBackupOperationsRequest getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

Class ListBackupOperationsRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite

Field Detail

PARENT_FIELD_NUMBER

FILTER_FIELD_NUMBER

PAGE_SIZE_FIELD_NUMBER

PAGE_TOKEN_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getParent

getParentBytes

getFilter

getFilterBytes

getPageSize

getPageToken

getPageTokenBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType