Cloud Bigtable V2 Client - Class GetSnapshotRequest (1.31.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class GetSnapshotRequest.

Request message for google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot 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.GetSnapshotRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The unique name of the requested snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

getName

Required. The unique name of the requested snapshot.

Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

Returns
Type Description
string

setName

Required. The unique name of the requested snapshot.

Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The unique name of the requested snapshot. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}. Please see Google\Cloud\Bigtable\Admin\V2\BigtableTableAdminClient::snapshotName() for help formatting this field.
Returns
Type Description
Google\Cloud\Bigtable\Admin\V2\GetSnapshotRequest