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.



2001
2002
2003
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2001

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) 


1914
1915
1916
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1914

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) 


1919
1920
1921
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1919

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) 


1925
1926
1927
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1925

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


1930
1931
1932
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1930

def endpoint_uris
  @endpoint_uris
end

#free_instance_metadata ⇒ Google::Apis::SpannerV1::FreeInstanceMetadata

Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. Corresponds to the JSON property freeInstanceMetadata

Returns:



1936
1937
1938
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1936

def free_instance_metadata
  @free_instance_metadata
end

#instance_type ⇒ String

The InstanceType of the current instance. Corresponds to the JSON property instanceType

Returns:

  • (String) 


1941
1942
1943
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1941

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


1961
1962
1963
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1961

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) 


1969
1970
1971
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1969

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) 


1978
1979
1980
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1978

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) 


1987
1988
1989
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1987

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) 


1994
1995
1996
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1994

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) 


1999
2000
2001
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1999

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2006

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)
  @free_instance_metadata = args[:free_instance_metadata] if args.key?(:free_instance_metadata)
  @instance_type = args[:instance_type] if args.key?(:instance_type)
  @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