- 2.2.0 (latest)
- 2.1.0
- 2.0.1-RC1
- 1.106.0
- 1.105.1
- 1.104.1
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.1
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.2
- 1.62.1
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.4
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.2
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
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The instance to list backups from. Values are of the form projects/<project>/instances/<instance>
.
↳ 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: <
, >
, <=
, >=
, !=
, =
, or :
. Colon :
is the contains operator. Filter rules are not case sensitive. The following fields in the 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
* * backup_schedules
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. * * expire_time < \"2018-03-28T14:50:00Z\"
- The backup expire_time
is before 2018-03-28T14:50:00Z. * * size_bytes > 10000000000
- The backup's size is greater than 10GB * * backup_schedules:daily
- The backup is created from a schedule with "daily" in its name.
↳ 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, page_token
should contain a next_page_token
from a previous ListBackupsResponse
to the same parent
and with the same filter
.
getParent
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>
.
string
setParent
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>
.
var
string
$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:
-
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 -
backup_schedulesYou 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 -
backup_schedules:daily- The backup is created from a schedule with "daily" in its name.
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:
-
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 -
backup_schedulesYou 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 -
backup_schedules:daily- The backup is created from a schedule with "daily" in its name.
var
string
$this
getPageSize
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
int
setPageSize
Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
var
int
$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
.
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
.
var
string
$this
static::build
parent
string
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>
. Please see DatabaseAdminClient::instanceName()
for help formatting this field.
