public sealed class ListBackupsRequest : IMessage<ListBackupsRequest>, IEquatable<ListBackupsRequest>, IDeepCloneable<ListBackupsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class ListBackupsRequest.
The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
Implements
IMessageListBackupsRequest, IEquatableListBackupsRequest, IDeepCloneableListBackupsRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Bigtable.Admin.V2Assembly
Google.Cloud.Bigtable.Admin.V2.dll
Constructors
ListBackupsRequest()
public ListBackupsRequest()
ListBackupsRequest(ListBackupsRequest)
public ListBackupsRequest(ListBackupsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListBackupsRequest |
Properties
Filter
public string Filter { get; set; }
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
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in [Backup][google.bigtable.admin.v2.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.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
If non-empty, page_token
should contain a
[next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token] from a
previous [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the same parent
and with the same
filter
.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
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/-
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsClusterName
public ClusterName ParentAsClusterName { get; set; }
ClusterName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
ClusterName |