Cloud Spanner V1 Client - Class CreateInstanceRequest (1.67.0)

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

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

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 project in which to create the instance. Values are of the form `projects/<project>`.
`↳ instance_id`	`string` Required. The ID of the instance 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`	`Google\Cloud\Spanner\Admin\Instance\V1\Instance` Required. The instance to create. The name may be omitted, but if specified must be `<parent>/instances/<instance_id>`.

getParent

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

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInstanceId

Required. The ID of the instance 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`

setInstanceId

Required. The ID of the instance 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`

getInstance

Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.

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

hasInstance

clearInstance

setInstance

Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.

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

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The name of the project in which to create the instance. Values are of the form `projects/<project>`. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::projectName() for help formatting this field.
`instanceId`	`string` Required. The ID of the instance 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`	`Google\Cloud\Spanner\Admin\Instance\V1\Instance` Required. The instance to create. The name may be omitted, but if specified must be `<parent>/instances/<instance_id>`.

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