Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest (v0.17.1)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest.

The request for ListBackupOperations.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

(::String) —
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.

#filter=

def filter=(value) -> ::String

Parameter

value (::String) —
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.

Returns

(::String) —
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.

#page_size

def page_size() -> ::Integer

Returns

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

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Returns

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

#page_token

def page_token() -> ::String

Returns

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

#page_token=

def page_token=(value) -> ::String

Parameter

value (::String) — If non-empty, page_token should contain a next_page_token from a previous ListBackupOperationsResponse to the same parent and with the same filter.

Returns

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

#parent

def parent() -> ::String

Returns

(::String) — Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.

Returns

(::String) — Required. The instance of the backup operations. Values are of the form projects/<project>/instances/<instance>.