public sealed class ListBackupsRequest : IMessage<ListBackupsRequest>, IEquatable<ListBackupsRequest>, IDeepCloneable<ListBackupsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class ListBackupsRequest.
The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
Implements
IMessageListBackupsRequest, IEquatableListBackupsRequest, IDeepCloneableListBackupsRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Spanner.Admin.Database.V1Assembly
Google.Cloud.Spanner.Admin.Database.V1.dll
Constructors
ListBackupsRequest()
public ListBackupsRequest()
ListBackupsRequest(ListBackupsRequest)
public ListBackupsRequest(ListBackupsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListBackupsRequest |
Properties
Filter
public string Filter { get; set; }
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][google.spanner.admin.database.v1.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)version_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.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"
- The backup
expire_time
is before 2018-03-28T14:50:00Z.
- The backup
size_bytes > 10000000000
- The backup's size is greater than 10GB
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.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same parent
and with the same
filter
.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsInstanceName
public InstanceName ParentAsInstanceName { get; set; }
Google.Cloud.Spanner.Common.V1.InstanceName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
Google.Cloud.Spanner.Common.V1.InstanceName |