Cloud Bigtable V2 Client - Class CreateClusterRequest (1.28.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
NameDescription
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
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
var string
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
var string
Returns
TypeDescription
$this

getCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Returns
TypeDescription
Google\Cloud\Bigtable\Admin\V2\Cluster|null

hasCluster

clearCluster

setCluster

Required. The cluster to be created.

Fields marked OutputOnly must be left blank.

Parameter
NameDescription
var Google\Cloud\Bigtable\Admin\V2\Cluster
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
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
TypeDescription
Google\Cloud\Bigtable\Admin\V2\CreateClusterRequest