Cloud Spanner V1 Client - Class InstancePartition (1.87.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class InstancePartition.

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

Generated from protobuf message google.spanner.admin.instance.v1.InstancePartition

Namespace

Google \ Cloud \ Spanner \ Admin \ Instance \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ 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 ListInstanceConfigs.

↳ display_name 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.

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

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

↳ state int

Output only. The current instance partition state.

↳ create_time Google\Protobuf\Timestamp

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

↳ update_time Google\Protobuf\Timestamp

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

↳ referencing_databases array

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 array

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.

getName

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
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getConfig

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

Returns
Type Description
string

setConfig

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

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
Type Description
string

setDisplayName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getNodeCount

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
Type Description
int

hasNodeCount

setNodeCount

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getProcessingUnits

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
Type Description
int

hasProcessingUnits

setProcessingUnits

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getState

Output only. The current instance partition state.

Returns
Type Description
int

setState

Output only. The current instance partition state.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getReferencingDatabases

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReferencingDatabases

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getReferencingBackups

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReferencingBackups

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEtag

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
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getComputeCapacity

Returns
Type Description
string