Class: Google::Spanner::Admin::Database::V1::ListBackupsRequest

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

Overview

The request for ListBackups.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ String

Returns An expression that filters the list of returned backups.

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 Backup are eligible for filtering:

  • name
    • database
    • state
    • create_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
    • expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
    • size_bytes

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:

  • name:Howl - The backup's name contains the string "howl".
    • database:prod
    • The database's name contains the string "prod".
    • state:CREATING - The backup is pending creation.
    • state:READY - The backup is fully created and ready for use.
    • (name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")
    • The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z.
    • expire_time < \"2018-03-28T14:50:00Z\"
      • The backup expire_time is before 2018-03-28T14:50:00Z.
    • size_bytes > 10000000000 - The backup's size is greater than 10GB.

Returns:

  • (String) —

    An expression that filters the list of returned backups.

    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 Backup are eligible for filtering:

    • name
      • database
      • state
      • create_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
      • expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
      • size_bytes

    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:

    • name:Howl - The backup's name contains the string "howl".
      • database:prod
      • The database's name contains the string "prod".
      • state:CREATING - The backup is pending creation.
      • state:READY - The backup is fully created and ready for use.
      • (name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")
      • The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z.
      • expire_time < \"2018-03-28T14:50:00Z\"
        • The backup expire_time is before 2018-03-28T14:50:00Z.
      • size_bytes > 10000000000 - The backup's size is greater than 10GB


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

class ListBackupsRequest; end

#page_size ⇒ Integer

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

Returns:

  • (Integer) —

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



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

class ListBackupsRequest; end

#page_token ⇒ String

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

Returns:



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

class ListBackupsRequest; end

#parent ⇒ String

Returns Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.

Returns:

  • (String) —

    Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>.



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

class ListBackupsRequest; end