Class: Google::Cloud::Bigtable::Admin::V2::ListBackupsRequest

Inherits:

Object

Object
Google::Cloud::Bigtable::Admin::V2::ListBackupsRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb

Overview

The request for ListBackups.

Instance Attribute Summary collapse

#filter ⇒ ::String
A filter expression that filters backups listed in the response.
#order_by ⇒ ::String
An expression for specifying the sort order of the results of the request.
#page_size ⇒ ::Integer
Number of backups to be returned in the response.
#page_token ⇒ ::String
If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.
#parent ⇒ ::String
Required.

Instance Attribute Details

#filter ⇒ `::String`

Returns A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive.

The fields eligible for filtering are:

name
source_table
state
start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
end_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

To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:

name:"exact" --> The backup's name is the string "exact".
name:howl --> The backup's name contains the string "howl".
source_table:prod --> The source_table'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 (start_time < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.
size_bytes > 10000000000 --> The backup's size is greater than 10GB.

Returns:

(::String) —
A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive.

The fields eligible for filtering are:
- name
- source_table
- state
- start_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
- end_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
To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:
- name:"exact" --> The backup's name is the string "exact".
- name:howl --> The backup's name contains the string "howl".
- source_table:prod --> The source_table'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 (start_time < \"2018-03-28T14:50:00Z\") --> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.
- size_bytes > 10000000000 --> The backup's size is greater than 10GB

# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 766

class ListBackupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ `::String`

Returns An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering.

Fields supported are:

name
source_table
expire_time
start_time
end_time
size_bytes
state

For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant.

If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

Returns:

(::String) —
An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering.

Fields supported are:
- name
- source_table
- expire_time
- start_time
- end_time
- size_bytes
- state
For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant.

If order_by is empty, results will be sorted by start_time in descending order starting from the most recently created backup.

# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 766

class ListBackupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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.

# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 766

class ListBackupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
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:

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

# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 766

class ListBackupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ `::String`

Returns Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

Returns:

(::String) —
Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.

# File 'proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb', line 766

class ListBackupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

Class: Google::Cloud::Bigtable::Admin::V2::ListBackupsRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

#order_by ⇒ ::String

#page_size ⇒ ::Integer

#page_token ⇒ ::String

#parent ⇒ ::String

#filter ⇒ `::String`

#order_by ⇒ `::String`

#page_size ⇒ `::Integer`

#page_token ⇒ `::String`

#parent ⇒ `::String`