Class: Google::Apis::BigtableadminV2::Cluster

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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster



331
332
333
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 331

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

Instance Attribute Details

#default_storage_type ⇒ String

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


301
302
303
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 301

def default_storage_type
  @default_storage_type
end

#location ⇒ String

(CreationOnly) 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 property location

Returns:

  • (String) 


310
311
312
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 310

def location
  @location
end

#name ⇒ String

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


317
318
319
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 317

def name
  @name
end

#serve_nodes ⇒ Fixnum

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) 


323
324
325
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 323

def serve_nodes
  @serve_nodes
end

#state ⇒ String

(OutputOnly) The current state of the cluster. Corresponds to the JSON property state

Returns:

  • (String) 


329
330
331
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 329

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



336
337
338
339
340
341
342
 
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 336

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