Cloud Spanner Instance Admin V1 API - Class Google::Cloud::Spanner::Admin::Instance::V1::InstancePartition (v0.16.0)

Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::InstancePartition.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#config

def config() -> ::String
Returns
  • (::String) — Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.

#config=

def config=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.
Returns
  • (::String) — Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and ListInstanceConfigs.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — 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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#etag

def etag() -> ::String
Returns
  • (::String) — 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.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[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.
Returns
  • (::String) — Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[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.

#node_count

def node_count() -> ::Integer
Returns
  • (::Integer) — 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.

#node_count=

def node_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#processing_units

def processing_units() -> ::Integer
Returns
  • (::Integer) — 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.

#processing_units=

def processing_units=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#referencing_backups

def referencing_backups() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#referencing_databases

def referencing_databases() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#state

def state() -> ::Google::Cloud::Spanner::Admin::Instance::V1::InstancePartition::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns