Cloud Bigtable V2 Client - Class CreateClusterRequest (1.28.3)

Version 1.28.3

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

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
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.
↳ cluster_id	string 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.
↳ cluster	Google\Cloud\Bigtable\Admin\V2\Cluster 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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

getCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\Cluster|null

hasCluster

clearCluster

setCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Parameter
Name	Description
var	Google\Cloud\Bigtable\Admin\V2\Cluster

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string 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 Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient::instanceName() for help formatting this field.
clusterId	string 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.
cluster	Google\Cloud\Bigtable\Admin\V2\Cluster Required. The cluster to be created. Fields marked OutputOnly must be left blank.

Returns
Type	Description
Google\Cloud\Bigtable\Admin\V2\CreateClusterRequest