Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::Instance.
An isolated set of Cloud Spanner resources on which databases can be hosted.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#autoscaling_config
def autoscaling_config() -> ::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig
- (::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig) — Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
#autoscaling_config=
def autoscaling_config=(value) -> ::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig
- value (::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig) — Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
- (::Google::Cloud::Spanner::Admin::Instance::V1::AutoscalingConfig) — Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance.
#config
def config() -> ::String
-
(::String) — Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See also InstanceConfig and ListInstanceConfigs.
#config=
def config=(value) -> ::String
-
value (::String) — Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See also InstanceConfig and ListInstanceConfigs.
-
(::String) — Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See also InstanceConfig and ListInstanceConfigs.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time at which the instance was created.
#display_name
def display_name() -> ::String
- (::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.
#display_name=
def display_name=(value) -> ::String
- value (::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.
- (::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.
#endpoint_uris
def endpoint_uris() -> ::Array<::String>
- (::Array<::String>) — Deprecated. This field is not populated.
#endpoint_uris=
def endpoint_uris=(value) -> ::Array<::String>
- value (::Array<::String>) — Deprecated. This field is not populated.
- (::Array<::String>) — Deprecated. This field is not populated.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
- Label keys must be between 1 and 63 characters long and must conform to
the following regular expression:
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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.
#node_count
def node_count() -> ::Integer
-
(::Integer) — The number of nodes allocated to this instance. At most one of either
node_count or processing_units should be present in the message.
Users can set the node_count field to specify the target number of nodes allocated to the instance.
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.
#node_count=
def node_count=(value) -> ::Integer
-
value (::Integer) — The number of nodes allocated to this instance. At most one of either
node_count or processing_units should be present in the message.
Users can set the node_count field to specify the target number of nodes allocated to the instance.
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.
-
(::Integer) — The number of nodes allocated to this instance. At most one of either
node_count or processing_units should be present in the message.
Users can set the node_count field to specify the target number of nodes allocated to the instance.
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
def processing_units() -> ::Integer
-
(::Integer) — The number of processing units allocated to this instance. At most one of
processing_units or node_count should be present in the message.
Users can set the processing_units field to specify the target number of processing units allocated to the instance.
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=
def processing_units=(value) -> ::Integer
-
value (::Integer) — The number of processing units allocated to this instance. At most one of
processing_units or node_count should be present in the message.
Users can set the processing_units field to specify the target number of processing units allocated to the instance.
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.
-
(::Integer) — The number of processing units allocated to this instance. At most one of
processing_units or node_count should be present in the message.
Users can set the processing_units field to specify the target number of processing units allocated to the instance.
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
def state() -> ::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State
-
(::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State) — 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 toREADY
.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. The time at which the instance was most recently updated.