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.


476
477
478
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 476

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

Instance Attribute Details

#default_storage_typeString

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)

447
448
449
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 447

def default_storage_type
  @default_storage_type
end

#locationString

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)

456
457
458
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 456

def location
  @location
end

#nameString

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)

462
463
464
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 462

def name
  @name
end

#serve_nodesFixnum

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)

469
470
471
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 469

def serve_nodes
  @serve_nodes
end

#stateString

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

Returns:

  • (String)

474
475
476
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 474

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


481
482
483
484
485
486
487
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 481

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