Cloud Bigtable V2 Client - Class ListSnapshotsRequest (2.4.0)

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 Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::clusterName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Bigtable\Admin\V2\ListSnapshotsRequest`