Generated from protobuf message google.bigtable.admin.v2.ListBackupsRequest
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
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/-.
↳ filter
string
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
↳ order_by
string
An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in 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.
↳ 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 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/-.
Returns
Type
Description
string
setParent
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/-.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
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
Returns
Type
Description
string
setFilter
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
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
An expression for specifying the sort order of the results of the request.
The string value should specify one or more fields in
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.
Returns
Type
Description
string
setOrderBy
An expression for specifying the sort order of the results of the request.
The string value should specify one or more fields in
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.
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.
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.
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.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
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/-. Please see
BigtableTableAdminClient::clusterName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ListBackupsRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListBackupsRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.ListBackupsRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.ListBackupsRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.ListBackupsRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.ListBackupsRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.ListBackupsRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.ListBackupsRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.ListBackupsRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.ListBackupsRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.ListBackupsRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.ListBackupsRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.ListBackupsRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.ListBackupsRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.ListBackupsRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.ListBackupsRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.ListBackupsRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.ListBackupsRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.ListBackupsRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.ListBackupsRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.ListBackupsRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.ListBackupsRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.ListBackupsRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.ListBackupsRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.ListBackupsRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.ListBackupsRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.ListBackupsRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.ListBackupsRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.ListBackupsRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.ListBackupsRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.ListBackupsRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.ListBackupsRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ListBackupsRequest.\n\nThe request for\n[ListBackups](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__listBackups__).\n\nGenerated from protobuf message `google.bigtable.admin.v2.ListBackupsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The cluster to list backups from. Values are of the\nform `projects/{project}/instances/{instance}/clusters/{cluster}`.\n\nUse `{cluster} = '-'` to list backups for all clusters in an instance,\ne.g., `projects/{project}/instances/{instance}/clusters/-`.\n\n### setParent\n\nRequired. The cluster to list backups from. Values are of the\nform `projects/{project}/instances/{instance}/clusters/{cluster}`.\n\nUse `{cluster} = '-'` to list backups for all clusters in an instance,\ne.g., `projects/{project}/instances/{instance}/clusters/-`.\n\n### getFilter\n\nA filter expression that filters backups listed in the response.\n\nThe expression must specify the field name, a comparison operator,\nand the value that you want to use for filtering. The value must be a\nstring, a number, or a boolean. The comparison operator must be\n\\\u003c, \\\u003e, \\\u003c=, \\\u003e=, !=, =, or :. Colon ':' represents a HAS operator which is\nroughly synonymous with equality. Filter rules are case insensitive.\nThe fields eligible for filtering are:\n\n- `name`\n- `source_table`\n- `state`\n- `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `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:\n- `name:\"exact\"` --\\\u003e The backup's name is the string \"exact\".\n- `name:howl` --\\\u003e The backup's name contains the string \"howl\".\n- `source_table:prod` --\\\u003e The source_table's name contains the string \"prod\".\n- `state:CREATING` --\\\u003e The backup is pending creation.\n- `state:READY` --\\\u003e The backup is fully created and ready for use.\n- `(name:howl) AND (start_time \u003c \\\"2018-03-28T14:50:00Z\\\")` --\\\u003e The backup name contains the string \"howl\" and start_time of the backup is before 2018-03-28T14:50:00Z.\n- `size_bytes \u003e 10000000000` --\\\u003e The backup's size is greater than 10GB\n\n### setFilter\n\nA filter expression that filters backups listed in the response.\n\nThe expression must specify the field name, a comparison operator,\nand the value that you want to use for filtering. The value must be a\nstring, a number, or a boolean. The comparison operator must be\n\\\u003c, \\\u003e, \\\u003c=, \\\u003e=, !=, =, or :. Colon ':' represents a HAS operator which is\nroughly synonymous with equality. Filter rules are case insensitive.\nThe fields eligible for filtering are:\n\n- `name`\n- `source_table`\n- `state`\n- `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)\n- `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:\n- `name:\"exact\"` --\\\u003e The backup's name is the string \"exact\".\n- `name:howl` --\\\u003e The backup's name contains the string \"howl\".\n- `source_table:prod` --\\\u003e The source_table's name contains the string \"prod\".\n- `state:CREATING` --\\\u003e The backup is pending creation.\n- `state:READY` --\\\u003e The backup is fully created and ready for use.\n- `(name:howl) AND (start_time \u003c \\\"2018-03-28T14:50:00Z\\\")` --\\\u003e The backup name contains the string \"howl\" and start_time of the backup is before 2018-03-28T14:50:00Z.\n- `size_bytes \u003e 10000000000` --\\\u003e The backup's size is greater than 10GB\n\n### getOrderBy\n\nAn expression for specifying the sort order of the results of the request.\n\nThe string value should specify one or more fields in\n[Backup](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Backup). The full syntax is described at\n\u003chttps://aip.dev/132#ordering\u003e.\nFields supported are:\n\n- name\n- source_table\n- expire_time\n- start_time\n- end_time\n- size_bytes\n- 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.\n\n### setOrderBy\n\nAn expression for specifying the sort order of the results of the request.\n\nThe string value should specify one or more fields in\n[Backup](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Backup). The full syntax is described at\n\u003chttps://aip.dev/132#ordering\u003e.\nFields supported are:\n\n- name\n- source_table\n- expire_time\n- start_time\n- end_time\n- size_bytes\n- 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.\n\n### getPageSize\n\nNumber of backups to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.\n\n### setPageSize\n\nNumber of backups to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.\n\n### getPageToken\n\nIf non-empty, `page_token` should contain a\n[next_page_token](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListBackupsResponse#_Google_Cloud_Bigtable_Admin_V2_ListBackupsResponse__getNextPageToken__)\nfrom a previous\n[ListBackupsResponse](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListBackupsResponse) to the\nsame `parent` and with the same `filter`.\n\n### setPageToken\n\nIf non-empty, `page_token` should contain a\n[next_page_token](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListBackupsResponse#_Google_Cloud_Bigtable_Admin_V2_ListBackupsResponse__getNextPageToken__)\nfrom a previous\n[ListBackupsResponse](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListBackupsResponse) to the\nsame `parent` and with the same `filter`.\n\n### static::build"]]