Class: Google::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb

Overview

The request for ListDatabaseOperations.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns An expression that filters the list of returned 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 RestoreDatabaseMetadata is type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.
    • metadata.<field_name> - any field in metadata.value.
    • 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. However, 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.RestoreDatabaseMetadata) AND
      (metadata.source_type:BACKUP) AND
      (metadata.backup_info.backup:backup_howl) AND
      (metadata.name:restored_howl) AND
      (metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND
      (error:*) - Return operations where:
    • The operation's metadata type is RestoreDatabaseMetadata.
    • The database is restored from a backup.
    • The backup name contains "backup_howl".
    • The restored database's name contains "restored_howl".
    • The operation started before 2018-03-28T14:50:00Z.
    • The operation resulted in an error.

Returns:

  • (String) —

    An expression that filters the list of returned 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 RestoreDatabaseMetadata is type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata.
      • metadata.<field_name> - any field in metadata.value.
      • 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. However, 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.RestoreDatabaseMetadata) AND
        (metadata.source_type:BACKUP) AND
        (metadata.backup_info.backup:backup_howl) AND
        (metadata.name:restored_howl) AND
        (metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND
        (error:*) - Return operations where:
      • The operation's metadata type is RestoreDatabaseMetadata.
      • The database is restored from a backup.
      • The backup name contains "backup_howl".
      • The restored database's name contains "restored_howl".
      • The operation started before 2018-03-28T14:50:00Z.
      • The operation resulted in an error.


273
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 273

class ListDatabaseOperationsRequest; end

#page_size ⇒ Integer

Returns 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.



273
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 273

class ListDatabaseOperationsRequest; end

#page_token ⇒ String

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

Returns:



273
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 273

class ListDatabaseOperationsRequest; end

#parent ⇒ String

Returns Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.

Returns:

  • (String) —

    Required. The instance of the database operations. Values are of the form projects/<project>/instances/<instance>.



273
 
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb', line 273

class ListDatabaseOperationsRequest; end