Class InstancePartition (3.46.0)

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

An isolated set of Cloud Spanner resources that databases can define placements on.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
Required. A unique identifier for the instance partition. 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. An instance partition's name cannot be changed after the instance partition is created.
config str
Required. The name of the instance partition'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 partition 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 partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state READY. This field is a member of oneof_ compute_capacity.
processing_units int
The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state READY. This field is a member of oneof_ compute_capacity.
state google.cloud.spanner_admin_instance_v1.types.InstancePartition.State
Output only. The current instance partition state.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the instance partition was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the instance partition was most recently updated.
referencing_databases MutableSequence[str]
Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.
referencing_backups MutableSequence[str]
Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.
etag str
Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.

Classes

State

State(value)

Indicates the current state of the instance partition.

Enum values:

STATE_UNSPECIFIED (0):
    Not specified.
CREATING (1):
    The instance partition is still being
    created. Resources may not be available yet, and
    operations such as creating placements using
    this instance partition may not work.
READY (2):
    The instance partition is fully created and
    ready to do work such as creating placements and
    using in databases.