Reference documentation and code samples for the Cloud Bigtable V2 Client class CreateInstanceRequest.
Request message for BigtableInstanceAdmin.CreateInstance.
Generated from protobuf message google.bigtable.admin.v2.CreateInstanceRequest
Namespace
Google \ Cloud \ Bigtable \ Admin \ V2Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The unique name of the project in which to create the new instance. Values are of the form |
↳ instance_id |
string
Required. The ID to be used when referring to the new instance within its project, e.g., just |
↳ instance |
Google\Cloud\Bigtable\Admin\V2\Instance
Required. The instance to create. Fields marked |
↳ clusters |
array|Google\Protobuf\Internal\MapField
Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just |
getParent
Required. The unique name of the project in which to create the new
instance. Values are of the form projects/{project}
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The unique name of the project in which to create the new
instance. Values are of the form projects/{project}
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getInstanceId
Required. The ID to be used when referring to the new instance within its
project, e.g., just myinstance
rather than
projects/myproject/instances/myinstance
.
Returns | |
---|---|
Type | Description |
string |
setInstanceId
Required. The ID to be used when referring to the new instance within its
project, e.g., just myinstance
rather than
projects/myproject/instances/myinstance
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getInstance
Required. The instance to create.
Fields marked OutputOnly
must be left blank.
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\Instance|null |
hasInstance
clearInstance
setInstance
Required. The instance to create.
Fields marked OutputOnly
must be left blank.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Bigtable\Admin\V2\Instance
|
Returns | |
---|---|
Type | Description |
$this |
getClusters
Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just mycluster
rather than
projects/myproject/instances/myinstance/clusters/mycluster
.
Fields marked OutputOnly
must be left blank.
Currently, at most four clusters can be specified.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setClusters
Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just mycluster
rather than
projects/myproject/instances/myinstance/clusters/mycluster
.
Fields marked OutputOnly
must be left blank.
Currently, at most four clusters can be specified.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The unique name of the project in which to create the new
instance. Values are of the form |
instanceId |
string
Required. The ID to be used when referring to the new instance within its
project, e.g., just |
instance |
Google\Cloud\Bigtable\Admin\V2\Instance
Required. The instance to create.
Fields marked |
clusters |
array
Required. The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just |
Returns | |
---|---|
Type | Description |
Google\Cloud\Bigtable\Admin\V2\CreateInstanceRequest |