Class: Google::Apis::SpannerV1::Instance

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



1351
1352
1353
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1351

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

Returns:

  • (String) 


1279
1280
1281
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1279

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

Returns:

  • (String) 


1285
1286
1287
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1285

def display_name
  @display_name
end

#endpoint_uris ⇒ Array<String>

Output only. A set of endpoint URIs based on your instance config that you can use instead of the global endpoint spanner.googleapis.com. For example, if your instance config is us-central1 (a regional config in Iowa), then your instance specific endpoints may include us-central1-spanner.googleapis.com. By calling these endpoints instead of the global endpoint, you optimize network routing which could reduce network latency. The client libraries, JDBC drivers, and other SDK clients automatically call these instance specific endpoints. If you are using DNS whitelists, firewalls, or filtering to control access to endpoints, make sure you grant access to *spanner.googleapis.com. Corresponds to the JSON property endpointUris

Returns:

  • (Array<String>) 


1300
1301
1302
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1300

def endpoint_uris
  @endpoint_uris
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

Returns:

  • (Hash<String,String>) 


1322
1323
1324
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1322

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 2 and 64 characters in length. Corresponds to the JSON property name

Returns:

  • (String) 


1330
1331
1332
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1330

def name
  @name
end

#node_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1340
1341
1342
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1340

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

Returns:

  • (String) 


1349
1350
1351
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1349

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 1356

def update!(**args)
  @config = args[:config] if args.key?(:config)
  @display_name = args[:display_name] if args.key?(:display_name)
  @endpoint_uris = args[:endpoint_uris] if args.key?(:endpoint_uris)
  @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