Struct ListBackupsParams (2.21.0)

Parameters for ListBackups.

Functions

set_cluster(std::string)

Sets the cluster_id.

Parameter
Name	Description
`c`	`std::string` the name of the cluster relative to the instance managed by the `TableAdmin` object. If no cluster_id is specified, the all backups in all clusters are listed. The full cluster name is `projects/<PROJECT_ID>/instances/<INSTANCE_ID>/clusters/<cluster_id>` where PROJECT_ID is obtained from the associated AdminClient and INSTANCE_ID is the instance_id() of the `TableAdmin` object.

Returns
Type	Description
`ListBackupsParams &`

set_filter(std::string)

Sets the filtering expression.

The fields eligible for filtering are:

name
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".
table:prod --> The 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

Parameter

Name Description

f

std::string

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.

Returns
Type	Description
`ListBackupsParams &`

set_order_by(std::string)

Sets the ordering expression.

For example, "start_time". The default sorting order is ascending. Append the " desc" suffix to the field name to sort descending, e.g. "start_time desc". Redundant space characters in the syntax are insignificant.

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

Parameter

Name Description

o

std::string

expression for specifying the sort order of the results of the request. The string value should specify only one field in google::bigtable::admin::v2::Backup. The following field names are supported:

name
table
expire_time
start_time
end_time
size_bytes
state

Returns
Type	Description
`ListBackupsParams &`

AsProto(std::string const &) const

Parameter
Name	Description
`instance_name`	`std::string const &`

Returns
Type	Description
`google::bigtable::admin::v2::ListBackupsRequest`