Class: Google::Cloud::Spanner::Admin::Instance::V1::Instance
- Inherits:
-
Object
- Object
- Google::Cloud::Spanner::Admin::Instance::V1::Instance
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb
Overview
An isolated set of Cloud Spanner resources on which databases can be hosted.
Defined Under Namespace
Modules: State Classes: LabelsEntry
Instance Attribute Summary collapse
-
#config ⇒ ::String
Required.
-
#display_name ⇒ ::String
Required.
-
#endpoint_uris ⇒ ::Array<::String>
Deprecated.
-
#labels ⇒ ::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.
-
#name ⇒ ::String
Required.
-
#node_count ⇒ ::Integer
Required.
-
#processing_units ⇒ ::Integer
The number of processing units allocated to this instance.
-
#state ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State
readonly
Output only.
Instance Attribute Details
#config ⇒ ::String
Returns Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also InstanceConfig and
ListInstanceConfigs.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#display_name ⇒ ::String
Returns 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.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#endpoint_uris ⇒ ::Array<::String>
Returns Deprecated. This field is not populated.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Returns 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.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#name ⇒ ::String
Returns 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.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#node_count ⇒ ::Integer
Returns Required. The number of nodes allocated to this 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.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#processing_units ⇒ ::Integer
Returns 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
.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |
#state ⇒ ::Google::Cloud::Spanner::Admin::Instance::V1::Instance::State (readonly)
Returns 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
.
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'proto_docs/google/spanner/admin/instance/v1/spanner_instance_admin.rb', line 163 class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class LabelsEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Indicates the current state of the instance. module State # Not specified. STATE_UNSPECIFIED = 0 # The instance is still being created. Resources may not be # available yet, and operations such as database creation may not # work. CREATING = 1 # The instance is fully created and ready to do work such as # creating databases. READY = 2 end end |