Class Instance (3.15.1)

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

An isolated set of Cloud Spanner resources on which databases can be hosted.

Attributes

NameDescription
name str
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form ``projects/
config str
Required. The name of the instance's configuration. Values are of the form ``projects/
display_name str
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.
node_count int
Required. The number of nodes allocated to this instance. This may be zero in API responses for instances that are not yet in state ``READY``. See `the documentation
processing_units int
The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for instances that are not yet in state ``READY``.
state google.cloud.spanner_admin_instance_v1.types.Instance.State
Output only. The current instance state. For `CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance]`, the state must be either omitted or set to ``CREATING``. For `UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance]`, the state must be either omitted or set to ``READY``.
labels Mapping[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]*[a-z0-9])?``. - Label values must be between 0 and 63 characters long and must conform to the regular expression ``([a-z]([-a-z0-9]*[a-z0-9])?)?``. - 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. And so 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.
endpoint_uris Sequence[str]
Deprecated. This field is not populated.

Inheritance

builtins.object > proto.message.Message > Instance

Classes

LabelsEntry

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

The abstract base class for a message.

Parameters
NameDescription
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.