Class ListBackupOperationsRequest.Builder (6.65.1)

public static final class ListBackupOperationsRequest.Builder extends GeneratedMessageV3.Builder<ListBackupOperationsRequest.Builder> implements ListBackupOperationsRequestOrBuilder

The request for ListBackupOperations.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupOperationsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListBackupOperationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

build()

public ListBackupOperationsRequest build()
Returns
Type Description
ListBackupOperationsRequest

buildPartial()

public ListBackupOperationsRequest buildPartial()
Returns
Type Description
ListBackupOperationsRequest

clear()

public ListBackupOperationsRequest.Builder clear()
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListBackupOperationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

clearFilter()

public ListBackupOperationsRequest.Builder clearFilter()

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 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 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.
    • 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.
    • 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.
    • 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 AND the database the backup was taken from has name containing string "test_db"
      • The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string "test_bkp"
    • The operation resulted in an error.

string filter = 2;

Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListBackupOperationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

clearPageSize()

public ListBackupOperationsRequest.Builder clearPageSize()

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;

Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListBackupOperationsRequest.Builder clearPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

clearParent()

public ListBackupOperationsRequest.Builder clearParent()

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) = { ... }

Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

clone()

public ListBackupOperationsRequest.Builder clone()
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListBackupOperationsRequest getDefaultInstanceForType()
Returns
Type Description
ListBackupOperationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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 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 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.
    • 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.
    • 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.
    • 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 AND the database the backup was taken from has name containing string "test_db"
      • The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string "test_bkp"
    • The operation resulted in an error.

string filter = 2;

Returns
Type Description
String

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 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 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.
    • 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.
    • 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.
    • 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 AND the database the backup was taken from has name containing string "test_db"
      • The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string "test_bkp"
    • The operation resulted in an error.

string filter = 2;

Returns
Type Description
ByteString

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;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

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) = { ... }

Returns
Type Description
String

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) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListBackupOperationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListBackupOperationsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

mergeFrom(ListBackupOperationsRequest other)

public ListBackupOperationsRequest.Builder mergeFrom(ListBackupOperationsRequest other)
Parameter
Name Description
other ListBackupOperationsRequest
Returns
Type Description
ListBackupOperationsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListBackupOperationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListBackupOperationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

setFilter(String value)

public ListBackupOperationsRequest.Builder setFilter(String value)

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 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 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.
    • 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.
    • 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.
    • 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 AND the database the backup was taken from has name containing string "test_db"
      • The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string "test_bkp"
    • The operation resulted in an error.

string filter = 2;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListBackupOperationsRequest.Builder setFilterBytes(ByteString value)

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 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 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.
    • 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.
    • 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.
    • 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 AND the database the backup was taken from has name containing string "test_db"
      • The operation's metadata type is CopyBackupMetadata AND the backup the backup was copied from has name containing string "test_bkp"
    • The operation resulted in an error.

string filter = 2;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListBackupOperationsRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListBackupOperationsRequest.Builder setPageToken(String value)

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListBackupOperationsRequest.Builder setPageTokenBytes(ByteString value)

If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListBackupOperationsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListBackupOperationsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListBackupOperationsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListBackupOperationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListBackupOperationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListBackupOperationsRequest.Builder
Overrides