Class: Google::Apis::BigtableadminV1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigtableadmin_v1/classes.rb,
lib/google/apis/bigtableadmin_v1/representations.rb,
lib/google/apis/bigtableadmin_v1/representations.rb

Overview

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.



181
182
183
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 181

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#default_storage_type ⇒ String

Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. Corresponds to the JSON property defaultStorageType

Returns:

  • (String) 


149
150
151
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 149

def default_storage_type
  @default_storage_type
end

#encryption_config ⇒ Google::Apis::BigtableadminV1::EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. Corresponds to the JSON property encryptionConfig

Returns:



154
155
156
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 154

def encryption_config
  @encryption_config
end

#location ⇒ String

Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form projects/project/locations/zone`. Corresponds to the JSON propertylocation`

Returns:

  • (String) 


162
163
164
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 162

def location
  @location
end

#name ⇒ String

The unique name of the cluster. Values are of the form projects/project/ instances/instance/clusters/a-z*. Corresponds to the JSON property name

Returns:

  • (String) 


168
169
170
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 168

def name
  @name
end

#serve_nodes ⇒ Fixnum

Required. The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. Corresponds to the JSON property serveNodes

Returns:

  • (Fixnum) 


174
175
176
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 174

def serve_nodes
  @serve_nodes
end

#state ⇒ String

Output only. The current state of the cluster. Corresponds to the JSON property state

Returns:

  • (String) 


179
180
181
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 179

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 186

def update!(**args)
  @default_storage_type = args[:default_storage_type] if args.key?(:default_storage_type)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @serve_nodes = args[:serve_nodes] if args.key?(:serve_nodes)
  @state = args[:state] if args.key?(:state)
end