Cloud Spanner V1 Client - Class CreateInstanceConfigRequest (1.85.0)

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

The request for CreateInstanceConfigRequest.

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

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 configuration. Values are of the form projects/<project>.

↳ instance_config_id string

Required. The ID of the instance configuration to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google-managed configurations.

↳ instance_config Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig

Required. The InstanceConfig proto of the configuration to create. instance_config.name must be <parent>/instanceConfigs/<instance_config_id>. instance_config.base_config must be a Google managed configuration name, e.g.

↳ validate_only bool

An option to validate, but not actually execute, a request, and provide the same response.

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceConfigId

Required. The ID of the instance configuration to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google-managed configurations.

Returns
Type Description
string

setInstanceConfigId

Required. The ID of the instance configuration to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google-managed configurations.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceConfig

Required. The InstanceConfig proto of the configuration to create.

instance_config.name must be <parent>/instanceConfigs/<instance_config_id>. instance_config.base_config must be a Google managed configuration name, e.g.

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

hasInstanceConfig

clearInstanceConfig

setInstanceConfig

Required. The InstanceConfig proto of the configuration to create.

instance_config.name must be <parent>/instanceConfigs/<instance_config_id>. instance_config.base_config must be a Google managed configuration name, e.g.

Parameter
Name Description
var Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig
Returns
Type Description
$this

getValidateOnly

An option to validate, but not actually execute, a request, and provide the same response.

Returns
Type Description
bool

setValidateOnly

An option to validate, but not actually execute, a request, and provide the same response.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The name of the project in which to create the instance configuration. Values are of the form projects/<project>. Please see Google\Cloud\Spanner\Admin\Instance\V1\InstanceAdminClient::projectName() for help formatting this field.

instanceConfig Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig

Required. The InstanceConfig proto of the configuration to create. instance_config.name must be <parent>/instanceConfigs/<instance_config_id>. instance_config.base_config must be a Google managed configuration name, e.g.

instanceConfigId string

Required. The ID of the instance configuration to create. Valid identifiers are of the form custom-[-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length. The custom- prefix is required to avoid name conflicts with Google-managed configurations.

Returns
Type Description
Google\Cloud\Spanner\Admin\Instance\V1\CreateInstanceConfigRequest