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.



526
527
528
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 526

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

Instance Attribute Details

#cluster_config ⇒ Google::Apis::BigtableadminV2::ClusterConfig

Configuration for a cluster. Corresponds to the JSON property clusterConfig

Returns:



487
488
489
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 487

def cluster_config
  @cluster_config
end

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


493
494
495
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 493

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:



498
499
500
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 498

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) 


506
507
508
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 506

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) 


512
513
514
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 512

def name
  @name
end

#serve_nodes ⇒ Fixnum

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization. Corresponds to the JSON property serveNodes

Returns:

  • (Fixnum) 


519
520
521
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 519

def serve_nodes
  @serve_nodes
end

#state ⇒ String

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

Returns:

  • (String) 


524
525
526
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 524

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



531
532
533
534
535
536
537
538
539
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 531

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