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.



1724
1725
1726
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1724

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) 


1658
1659
1660
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1658

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) 


1664
1665
1666
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1664

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


1669
1670
1671
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1669

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


1689
1690
1691
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1689

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) 


1697
1698
1699
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1697

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) 


1706
1707
1708
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1706

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) 


1715
1716
1717
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1715

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) 


1722
1723
1724
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1722

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1729

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