Class InstanceConfig (3.51.0) 

InstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes
Name Description
name str
A unique identifier for the instance configuration. Values are of the form projects/a-z][-a-z0-9]*. User instance configuration must start with custom-.
display_name str
The name of this instance configuration as it appears in UIs.
config_type google.cloud.spanner_admin_instance_v1.types.InstanceConfig.Type
Output only. Whether this instance configuration is a Google-managed or user-managed configuration.
replicas MutableSequence[google.cloud.spanner_admin_instance_v1.types.ReplicaInfo]
The geographic placement of nodes in this instance configuration and their replication properties.
optional_replicas MutableSequence[google.cloud.spanner_admin_instance_v1.types.ReplicaInfo]
Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.
base_config str
Base configuration name, e.g. projects/
labels MutableMapping[str, str]
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 str
etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.
leader_options MutableSequence[str]
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 configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.
state google.cloud.spanner_admin_instance_v1.types.InstanceConfig.State
Output only. The current instance configuration state. Applicable only for USER_MANAGED configurations.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

Indicates the current state of the instance configuration.

Type

Type(value)

The type of this configuration.