Cloud Spanner V1 Client - Class Instance (1.54.2)

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

An isolated set of Cloud Spanner resources on which databases can be hosted.

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

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.
`↳ config`	`string` Required. The name of the instance'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 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. This may be zero in API responses for instances that are not yet in state `READY`. See the documentation for more information about nodes and processing units.
`↳ processing_units`	`int` The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for instances that are not yet in state `READY`. See the documentation for more information about nodes and processing units.
`↳ state`	`int` Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` 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.
`↳ endpoint_uris`	`array` Deprecated. This field is not populated.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time at which the instance was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time at which the instance was most recently updated.

getName

Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 2 and 64 characters in length.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setName

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfig

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

Generated from protobuf field string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
`string`

setConfig

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

Generated from protobuf field string config = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

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.

Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setDisplayName

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.

Generated from protobuf field string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNodeCount

The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. This may be zero in API responses for instances that are not yet in state READY.

See the documentation for more information about nodes and processing units.

Generated from protobuf field int32 node_count = 5;

Returns
Type	Description
`int`

setNodeCount

See the documentation for more information about nodes and processing units.

Generated from protobuf field int32 node_count = 5;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getProcessingUnits

The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for instances that are not yet in state READY.

See the documentation for more information about nodes and processing units.

Generated from protobuf field int32 processing_units = 9;

Returns
Type	Description
`int`

setProcessingUnits

See the documentation for more information about nodes and processing units.

Generated from protobuf field int32 processing_units = 9;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getState

Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`

setState

Output only. The current instance state. For CreateInstance, the state must be either omitted or set to CREATING. For UpdateInstance, the state must be either omitted or set to READY.

Generated from protobuf field .google.spanner.admin.instance.v1.Instance.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getLabels

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.

Generated from protobuf field map<string, string> labels = 7;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

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.

Generated from protobuf field map<string, string> labels = 7;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getEndpointUris

Deprecated. This field is not populated.

Generated from protobuf field repeated string endpoint_uris = 8;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setEndpointUris

Deprecated. This field is not populated.

Generated from protobuf field repeated string endpoint_uris = 8;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`