Cloud Bigtable V2 Client - Class GetClusterRequest (1.31.1)

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

Request message for BigtableInstanceAdmin.GetCluster.

Generated from protobuf message google.bigtable.admin.v2.GetClusterRequest

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 cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

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