REST Resource: projects.instances.instancePartitions

Resource: InstancePartition

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

JSON representation 
{
  "name": string,
  "config": string,
  "displayName": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "referencingDatabases": [
    string
  ],
  "referencingBackups": [
    string
  ],
  "etag": string,

  // Union field compute_capacity can be only one of the following:
  "nodeCount": integer,
  "processingUnits": integer
  // End of list of possible types for union field compute_capacity.
}
Fields
name

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.
config

string

Required. The name of the instance partition's configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also InstanceConfig and instanceConfigs.list.
displayName

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.
state

enum (State)

Output only. The current instance partition state.
createTime

string (Timestamp format)

Output only. The time at which the instance partition was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time at which the instance partition was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
referencingDatabases[]

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.
referencingBackups[]
(deprecated)

string

Output only. Deprecated: This field is not populated. 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

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.
Union field compute_capacity. Compute capacity defines amount of server and storage resources that are available to the databases in an instance partition. At most, one of either node_count orprocessing_units should be present in the message. For more information, see Compute capacity, nodes, and processing units. compute_capacity can be only one of the following:
nodeCount

integer

The number of nodes allocated to this instance partition.

Users can set the nodeCount 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.
processingUnits

integer

The number of processing units allocated to this instance partition.

Users can set the processingUnits field to specify the target number of processing units allocated to the instance partition.

This might be zero in API responses for instance partitions that are not yet in the READY state.

State

Indicates the current state of the instance partition.

Enums
STATE_UNSPECIFIED Not specified.
CREATING 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 The instance partition is fully created and ready to do work such as creating placements and using in databases.

Methods

create

 Creates an instance partition and begins preparing it to be used.

delete

 Deletes an existing instance partition.

get

 Gets information about a particular instance partition.

list

 Lists all instance partitions for the given instance.

patch

 Updates an instance partition, and begins allocating or releasing resources as requested.