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

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

Constructor Details

#initialize(**args) ⇒ Cluster

Returns a new instance of Cluster.



421
422
423
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 421

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) 


389
390
391
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 389

def default_storage_type
  @default_storage_type
end

#encryption_config ⇒ Google::Apis::BigtableadminV2::EncryptionConfig

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

Returns:



394
395
396
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 394

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) 


402
403
404
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 402

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) 


408
409
410
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 408

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) 


414
415
416
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 414

def serve_nodes
  @serve_nodes
end

#state ⇒ String

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

Returns:

  • (String) 


419
420
421
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 419

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



426
427
428
429
430
431
432
433
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 426

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