Instance
class Instance extends Message
An isolated set of Cloud Spanner resources on which databases can be hosted.
Protobuf type Google\Spanner\Admin\Instance\V1\Instance
Methods
No description
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 6 and 30 characters in length.
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 6 and 30 characters in length.
Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Required. The descriptive name for this instance as it appears in UIs.
Required. The descriptive name for this instance as it appears in UIs.
Required. The number of nodes allocated to this instance.
Required. The number of nodes allocated to this instance.
Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to CREATING
. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
either omitted or set to READY
.
Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to CREATING
. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
either omitted or set to READY
.
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.
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.
Details
at line 83
__construct()
at line 97
string
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 6 and 30 characters in length.
Generated from protobuf field string name = 1;
at line 111
setName(string $var)
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 6 and 30 characters in length.
Generated from protobuf field string name = 1;
at line 126
string
getConfig()
Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Generated from protobuf field string config = 2;
at line 140
setConfig(string $var)
Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
[ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
Generated from protobuf field string config = 2;
at line 153
string
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;
at line 165
setDisplayName(string $var)
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;
at line 177
int
getNodeCount()
Required. The number of nodes allocated to this instance.
Generated from protobuf field int32 node_count = 5;
at line 188
setNodeCount(int $var)
Required. The number of nodes allocated to this instance.
Generated from protobuf field int32 node_count = 5;
at line 204
int
getState()
Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to CREATING
. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
either omitted or set to READY
.
Generated from protobuf field .google.spanner.admin.instance.v1.Instance.State state = 6;
at line 219
setState(int $var)
Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to CREATING
. For
[UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be
either omitted or set to READY
.
Generated from protobuf field .google.spanner.admin.instance.v1.Instance.State state = 6;
at line 248
RepeatedField
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]*[a-z0-9])?
.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
.
* 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;
at line 276
setLabels(array|RepeatedField $var)
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]*[a-z0-9])?
.
* Label values must be between 0 and 63 characters long and must conform
to the regular expression ([a-z]([-a-z0-9]*[a-z0-9])?)?
.
* 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;