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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/spanner_v1/classes.rb,
lib/google/apis/spanner_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



1879
1880
1881
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1879

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//instanceConfigs/. See also InstanceConfig and ListInstanceConfigs. Corresponds to the JSON property config

Returns:

  • (String) 


1803
1804
1805
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1803

def config
  @config
end

#create_time ⇒ String

Output only. The time at which the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1808
1809
1810
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1808

def create_time
  @create_time
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) 


1814
1815
1816
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1814

def display_name
  @display_name
end

#endpoint_uris ⇒ Array<String>

Deprecated. This field is not populated. Corresponds to the JSON property endpointUris

Returns:

  • (Array<String>) 


1819
1820
1821
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1819

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-z0, 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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1839
1840
1841
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1839

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//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) 


1847
1848
1849
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1847

def name
  @name
end

#node_count ⇒ Fixnum

The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. 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. Corresponds to the JSON property nodeCount

Returns:

  • (Fixnum) 


1856
1857
1858
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1856

def node_count
  @node_count
end

#processing_units ⇒ Fixnum

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. See the documentation for more information about nodes and processing units. Corresponds to the JSON property processingUnits

Returns:

  • (Fixnum) 


1865
1866
1867
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1865

def processing_units
  @processing_units
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) 


1872
1873
1874
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1872

def state
  @state
end

#update_time ⇒ String

Output only. The time at which the instance was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1877
1878
1879
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1877

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1884

def update!(**args)
  @config = args[:config] if args.key?(:config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @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)
  @processing_units = args[:processing_units] if args.key?(:processing_units)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end