- 3.46.0 (latest)
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.1
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.1
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.1
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.2
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.1
- 3.14.1
- 3.13.0
- 3.12.1
- 3.11.1
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.1.1
- 2.0.0
- 1.19.3
- 1.18.0
- 1.17.1
- 1.16.0
- 1.15.1
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)
An isolated set of Cloud Spanner resources on which databases can be hosted.
Attributes | |
---|---|
Name | Description |
name |
str
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/ a-z][-a-z0-9]*[a-z0-9] .
The final segment of the name must be between 2 and 64
characters in length.
|
config |
str
Required. The name of the instance's configuration. Values are of the form projects/ . See
also
InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig]
and
ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] .
|
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
The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the 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. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state READY .
See `the
documentation |
autoscaling_config |
google.cloud.spanner_admin_instance_v1.types.AutoscalingConfig
Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. |
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 |
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. 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 |
MutableSequence[str]
Deprecated. This field is not populated. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the instance was created. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the instance was most recently updated. |
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,
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 |
State
State(value)
Indicates the current state of the instance.
Values: STATE_UNSPECIFIED (0): Not specified. CREATING (1): The instance is still being created. Resources may not be available yet, and operations such as database creation may not work. READY (2): The instance is fully created and ready to do work such as creating databases.