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.



231
232
233
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 231

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

Instance Attribute Details

#cluster_config ⇒ Google::Apis::BigtableadminV1::ClusterConfig

Configuration for a cluster. Corresponds to the JSON property clusterConfig

Returns:



193
194
195
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 193

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) 


199
200
201
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 199

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:



204
205
206
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 204

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) 


212
213
214
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 212

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) 


218
219
220
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 218

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) 


224
225
226
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 224

def serve_nodes
  @serve_nodes
end

#state ⇒ String

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

Returns:

  • (String) 


229
230
231
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 229

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



236
237
238
239
240
241
242
243
244
 
# File 'lib/google/apis/bigtableadmin_v1/classes.rb', line 236

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