Cloud Spanner V1 Client - Class CreateInstancePartitionRequest (1.83.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class CreateInstancePartitionRequest.

The request for CreateInstancePartition.

Generated from protobuf message google.spanner.admin.instance.v1.CreateInstancePartitionRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The name of the instance in which to create the instance partition. Values are of the form `projects/<project>/instances/<instance>`.
`↳ instance_partition_id`	`string` Required. The ID of the instance partition to create. Valid identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.
`↳ instance_partition`	`Google\Cloud\Spanner\Admin\Instance\V1\InstancePartition` Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be `<parent>/instancePartitions/<instance_partition_id>`.

getParent

Required. The name of the instance in which to create the instance partition. Values are of the form projects/<project>/instances/<instance>.

Returns
Type	Description
`string`

setParent

Required. The name of the instance in which to create the instance partition. Values are of the form projects/<project>/instances/<instance>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstancePartitionId

Required. The ID of the instance partition to create. Valid identifiers are of the form [a-z][-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length.

Returns
Type	Description
`string`

setInstancePartitionId

Required. The ID of the instance partition to create. Valid identifiers are of the form [a-z][-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstancePartition

Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be <parent>/instancePartitions/<instance_partition_id>.

Returns
Type	Description
`Google\Cloud\Spanner\Admin\Instance\V1\InstancePartition\|null`

hasInstancePartition

clearInstancePartition

setInstancePartition

Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be <parent>/instancePartitions/<instance_partition_id>.

Parameter
Name	Description
`var`	`Google\Cloud\Spanner\Admin\Instance\V1\InstancePartition`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The name of the instance in which to create the instance partition. Values are of the form `projects/<project>/instances/<instance>`. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::instanceName() for help formatting this field.
`instancePartition`	`Google\Cloud\Spanner\Admin\Instance\V1\InstancePartition` Required. The instance partition to create. The instance_partition.name may be omitted, but if specified must be `<parent>/instancePartitions/<instance_partition_id>`.
`instancePartitionId`	`string` Required. The ID of the instance partition to create. Valid identifiers are of the form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length.

Returns
Type	Description
`Google\Cloud\Spanner\Admin\Instance\V1\CreateInstancePartitionRequest`