Cloud Spanner V1 Client - Class CreateInstanceConfigRequest (1.54.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ instance_config_id string

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

Values are of the form projects/<project>.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

Required. The name of the project in which to create the instance config.

Values are of the form projects/<project>.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceConfigId

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

Generated from protobuf field string instance_config_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setInstanceConfigId

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

Generated from protobuf field string instance_config_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig instance_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig instance_config = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Spanner\Admin\Instance\V1\InstanceConfig
Returns
TypeDescription
$this

getValidateOnly

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

Generated from protobuf field bool validate_only = 4;

Returns
TypeDescription
bool

setValidateOnly

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

Generated from protobuf field bool validate_only = 4;

Parameter
NameDescription
var bool
Returns
TypeDescription
$this