- 1.104.0 (latest)
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.1
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.2
- 1.62.1
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.4
- 1.57.0
- 1.56.0
- 1.55.0
- 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.
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]*
.
string
setName
A unique identifier for the instance configuration. Values
are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*
.
var
string
$this
getDisplayName
The name of this instance configuration as it appears in UIs.
string
setDisplayName
The name of this instance configuration as it appears in UIs.
var
string
$this
getConfigType
Output only. Whether this instance config is a Google or User Managed Configuration.
int
setConfigType
Output only. Whether this instance config is a Google or User Managed Configuration.
var
int
$this
getReplicas
The geographic placement of nodes in this instance configuration and their replication properties.
setReplicas
The geographic placement of nodes in this instance configuration and their replication properties.
$this
getOptionalReplicas
Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
setOptionalReplicas
Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
$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.
string
setBaseConfig
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.
var
string
$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.
setLabels
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.
$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.
string
setEtag
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.
var
string
$this
getLeaderOptions
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
setLeaderOptions
Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration.
var
string[]
$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.
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.
var
bool
$this
getState
Output only. The current instance config state.
int
setState
Output only. The current instance config state.
var
int
$this
