Reference documentation and code samples for the Cloud Spanner V1 Client class ListBackupsRequest.
The request for ListBackups.
Generated from protobuf message google.spanner.admin.database.v1.ListBackupsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The instance to list backups from. Values are of the form |
↳ filter |
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: |
↳ page_size |
int
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
↳ page_token |
string
If non-empty, |
getParent
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
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:
namedatabasestatecreate_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_bytesYou 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_timeof 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_timeis before 2018-03-28T14:50:00Z.
- The backup
size_bytes > 10000000000- The backup's size is greater than 10GB
Generated from protobuf field string filter = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
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:
namedatabasestatecreate_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_bytesYou 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_timeof 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_timeis before 2018-03-28T14:50:00Z.
- The backup
size_bytes > 10000000000- The backup's size is greater than 10GB
Generated from protobuf field string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Generated from protobuf field int32 page_size = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Generated from protobuf field int32 page_size = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
If non-empty, page_token should contain a
next_page_token from a
previous ListBackupsResponse to the same parent and with the same
filter.
Generated from protobuf field string page_token = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
If non-empty, page_token should contain a
next_page_token from a
previous ListBackupsResponse to the same parent and with the same
filter.
Generated from protobuf field string page_token = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |