Reference documentation and code samples for the Cloud Bigtable V2 Client class ListSnapshotsRequest.
Request message for
google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots
Note: This is a private alpha release of Cloud Bigtable snapshots. This
feature is not currently available to most Cloud Bigtable customers. This
feature might be changed in backward-incompatible ways and is not recommended
for production use. It is not subject to any SLA or deprecation policy.
Generated from protobuf message google.bigtable.admin.v2.ListSnapshotsRequest
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 unique name of the cluster for which snapshots should be listed. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list snapshots for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-.
↳ page_size
int
The maximum number of snapshots to return per page. CURRENTLY UNIMPLEMENTED AND IGNORED.
↳ page_token
string
The value of next_page_token returned by a previous call.
getParent
Required. The unique name of the cluster for which snapshots should be
listed. Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}.
Use {cluster} = '-' to list snapshots for all clusters in an instance,
e.g., projects/{project}/instances/{instance}/clusters/-.
Returns
Type
Description
string
setParent
Required. The unique name of the cluster for which snapshots should be
listed. Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}.
Use {cluster} = '-' to list snapshots for all clusters in an instance,
e.g., projects/{project}/instances/{instance}/clusters/-.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of snapshots to return per page.
CURRENTLY UNIMPLEMENTED AND IGNORED.
Returns
Type
Description
int
setPageSize
The maximum number of snapshots to return per page.
CURRENTLY UNIMPLEMENTED AND IGNORED.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
The value of next_page_token returned by a previous call.
Returns
Type
Description
string
setPageToken
The value of next_page_token returned by a previous call.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The unique name of the cluster for which snapshots should be
listed. Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}.
Use {cluster} = '-' to list snapshots 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-08-28 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ListSnapshotsRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/Admin.V2.ListSnapshotsRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/Admin.V2.ListSnapshotsRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/Admin.V2.ListSnapshotsRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/Admin.V2.ListSnapshotsRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/Admin.V2.ListSnapshotsRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/Admin.V2.ListSnapshotsRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/Admin.V2.ListSnapshotsRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/Admin.V2.ListSnapshotsRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/Admin.V2.ListSnapshotsRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/Admin.V2.ListSnapshotsRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/Admin.V2.ListSnapshotsRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/Admin.V2.ListSnapshotsRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/Admin.V2.ListSnapshotsRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/Admin.V2.ListSnapshotsRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/Admin.V2.ListSnapshotsRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/Admin.V2.ListSnapshotsRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/Admin.V2.ListSnapshotsRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/Admin.V2.ListSnapshotsRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/Admin.V2.ListSnapshotsRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/Admin.V2.ListSnapshotsRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/Admin.V2.ListSnapshotsRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/Admin.V2.ListSnapshotsRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/Admin.V2.ListSnapshotsRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/Admin.V2.ListSnapshotsRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/Admin.V2.ListSnapshotsRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/Admin.V2.ListSnapshotsRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/Admin.V2.ListSnapshotsRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/Admin.V2.ListSnapshotsRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/Admin.V2.ListSnapshotsRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/Admin.V2.ListSnapshotsRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/Admin.V2.ListSnapshotsRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ListSnapshotsRequest.\n\nRequest message for\n[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots](/php/docs/reference/cloud-bigtable/latest/Admin.V2.Client.BigtableTableAdminClient#_Google_Cloud_Bigtable_Admin_V2_Client_BigtableTableAdminClient__listSnapshots__)\nNote: This is a private alpha release of Cloud Bigtable snapshots. This\nfeature is not currently available to most Cloud Bigtable customers. This\nfeature might be changed in backward-incompatible ways and is not recommended\nfor production use. It is not subject to any SLA or deprecation policy.\n\nGenerated from protobuf message `google.bigtable.admin.v2.ListSnapshotsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ Admin \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The unique name of the cluster for which snapshots should be\nlisted. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\nUse `{cluster} = '-'` to list snapshots for all clusters in an instance,\ne.g., `projects/{project}/instances/{instance}/clusters/-`.\n\n### setParent\n\nRequired. The unique name of the cluster for which snapshots should be\nlisted. Values are of the form\n`projects/{project}/instances/{instance}/clusters/{cluster}`.\n\nUse `{cluster} = '-'` to list snapshots for all clusters in an instance,\ne.g., `projects/{project}/instances/{instance}/clusters/-`.\n\n### getPageSize\n\nThe maximum number of snapshots to return per page.\n\nCURRENTLY UNIMPLEMENTED AND IGNORED.\n\n### setPageSize\n\nThe maximum number of snapshots to return per page.\n\nCURRENTLY UNIMPLEMENTED AND IGNORED.\n\n### getPageToken\n\nThe value of `next_page_token` returned by a previous call.\n\n### setPageToken\n\nThe value of `next_page_token` returned by a previous call.\n\n### static::build"]]
