Cloud Bigtable V2 Client - Class CreateClusterRequest (2.8.0)

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

Request message for BigtableInstanceAdmin.CreateCluster.

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

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

↳ cluster_idstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

↳ clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

getParent

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

Returns
TypeDescription
string

setParent

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getClusterId

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

Returns
TypeDescription
string

setClusterId

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Returns
TypeDescription
Cluster|null

hasCluster

clearCluster

setCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Parameter
NameDescription
varCluster
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}. Please see BigtableInstanceAdminClient::instanceName() for help formatting this field.

clusterIdstring

Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.

clusterCluster

Required. The cluster to be created. Fields marked OutputOnly must be left blank.

Returns
TypeDescription
CreateClusterRequest