Cloud Spanner V1 Client - Class InstanceConfig (1.54.2)

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

A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` A unique identifier for the instance configuration. Values are of the form `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`.
`↳ display_name`	`string` The name of this instance configuration as it appears in UIs.
`↳ config_type`	`int` Output only. Whether this instance config is a Google or User Managed Configuration.
`↳ replicas`	`array<Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>` The geographic placement of nodes in this instance configuration and their replication properties.
`↳ optional_replicas`	`array<Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>` Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
`↳ base_config`	`string` Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z][a-z0-9_-]{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.
`↳ etag`	`string` etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
`↳ leader_options`	`array` Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
`↳ reconciling`	`bool` Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.
`↳ state`	`int` Output only. The current instance config state.

getName

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.

Generated from protobuf field string name = 1;

Returns
Type	Description
`string`

setName

A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*.

Generated from protobuf field string name = 1;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

The name of this instance configuration as it appears in UIs.

Generated from protobuf field string display_name = 2;

Returns
Type	Description
`string`

setDisplayName

The name of this instance configuration as it appears in UIs.

Generated from protobuf field string display_name = 2;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfigType

Output only. Whether this instance config is a Google or User Managed Configuration.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setConfigType

Output only. Whether this instance config is a Google or User Managed Configuration.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.Type config_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getReplicas

The geographic placement of nodes in this instance configuration and their replication properties.

Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setReplicas

The geographic placement of nodes in this instance configuration and their replication properties.

Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo replicas = 3;

Parameter
Name	Description
`var`	`array<Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>`

Returns
Type	Description
`$this`

getOptionalReplicas

Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.

Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setOptionalReplicas

Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.

Generated from protobuf field repeated .google.spanner.admin.instance.v1.ReplicaInfo optional_replicas = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`array<Google\Cloud\Spanner\Admin\Instance\V1\ReplicaInfo>`

Returns
Type	Description
`$this`

getBaseConfig

Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. base_config must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.

Generated from protobuf field string base_config = 7 [(.google.api.resource_reference) = {

Returns
Type	Description
`string`

setBaseConfig

Generated from protobuf field string base_config = 7 [(.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.

And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}.
Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Generated from protobuf field map<string, string> labels = 8;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).

Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z][a-z0-9_-]{0,62}.
Label values must be between 0 and 63 characters long and must conform to the regular expression [a-z0-9_-]{0,63}.
No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "" + value would prove problematic if we were to allow "" in a future release.

Generated from protobuf field map<string, string> labels = 8;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEtag

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config.

If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

Generated from protobuf field string etag = 9;

Returns
Type	Description
`string`

setEtag

If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.

Generated from protobuf field string etag = 9;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLeaderOptions

Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

Generated from protobuf field repeated string leader_options = 4;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLeaderOptions

Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.

Generated from protobuf field repeated string leader_options = 4;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getReconciling

Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.

Generated from protobuf field bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`bool`

setReconciling

Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.

Generated from protobuf field bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getState

Output only. The current instance config state.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setState

Output only. The current instance config state.

Generated from protobuf field .google.spanner.admin.instance.v1.InstanceConfig.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`