Class Instance (3.54.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. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the READY state. For more information, see `Compute capacity, nodes, and processing units
processing_units int
The number of processing units allocated to this instance. At most, one of either 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. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the READY state. For more information, see `Compute capacity, nodes and processing units
replica_compute_capacity MutableSequence[google.cloud.spanner_admin_instance_v1.types.ReplicaComputeCapacity]
Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity.
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.
instance_type google.cloud.spanner_admin_instance_v1.types.Instance.InstanceType
The InstanceType of the current instance.
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.
free_instance_metadata google.cloud.spanner_admin_instance_v1.types.FreeInstanceMetadata
Free instance metadata. Only populated for free instances.
edition google.cloud.spanner_admin_instance_v1.types.Instance.Edition
Optional. The Edition of the current instance.
default_backup_schedule_type google.cloud.spanner_admin_instance_v1.types.Instance.DefaultBackupScheduleType
Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the AUTOMATIC value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the GetInstance or ListInstances response, if the value of default_backup_schedule_type isn't set, or set to NONE, Spanner doesn't create a default backup schedule for new databases in the instance.

Classes

DefaultBackupScheduleType

DefaultBackupScheduleType(value)

Indicates the default backup schedule <https://cloud.google.com/spanner/docs/backup#default-backup-schedules>__ behavior for new databases within the instance.

Edition

Edition(value)

The edition selected for this instance. Different editions provide different capabilities at different price points.

InstanceType

InstanceType(value)

The type of this instance. The type can be used to distinguish product variants, that can affect aspects like: usage restrictions, quotas and billing. Currently this is used to distinguish FREE_INSTANCE vs PROVISIONED instances.

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.