Class: Google::Apis::SpannerV1::Instance
- Inherits:
-
Object
- Object
- Google::Apis::SpannerV1::Instance
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/spanner_v1/classes.rb,
generated/google/apis/spanner_v1/representations.rb,
generated/google/apis/spanner_v1/representations.rb
Overview
An isolated set of Cloud Spanner resources on which databases can be hosted.
Instance Attribute Summary collapse
-
#config ⇒ String
Required.
-
#display_name ⇒ String
Required.
-
#labels ⇒ Hash<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 ⇒ Fixnum
Required.
-
#state ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Instance
constructor
A new instance of Instance.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Instance
Returns a new instance of Instance
949 950 951 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 949 def initialize(**args) update!(**args) end |
Instance Attribute Details
#config ⇒ String
Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>
. See
also InstanceConfig and
ListInstanceConfigs.
Corresponds to the JSON property config
893 894 895 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 893 def config @config end |
#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.
Corresponds to the JSON property displayName
899 900 901 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 899 def display_name @display_name end |
#labels ⇒ Hash<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]*[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.
Corresponds to the JSON property
labels
921 922 923 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 921 def labels @labels end |
#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]
. The final
segment of the name must be between 6 and 30 characters in length.
Corresponds to the JSON property name
929 930 931 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 929 def name @name end |
#node_count ⇒ Fixnum
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.
Corresponds to the JSON property nodeCount
938 939 940 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 938 def node_count @node_count end |
#state ⇒ String
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
.
Corresponds to the JSON property state
947 948 949 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 947 def state @state end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
954 955 956 957 958 959 960 961 |
# File 'generated/google/apis/spanner_v1/classes.rb', line 954 def update!(**args) @config = args[:config] if args.key?(:config) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @node_count = args[:node_count] if args.key?(:node_count) @state = args[:state] if args.key?(:state) end |