Class: Google::Apis::DataprocV1::Cluster

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dataproc_v1/classes.rb,
generated/google/apis/dataproc_v1/representations.rb,
generated/google/apis/dataproc_v1/representations.rb

Overview

Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.

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



380
381
382
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 380

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

Instance Attribute Details

#cluster_name ⇒ String

Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. Corresponds to the JSON property clusterName

Returns:

  • (String) 


367
368
369
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 367

def cluster_name
  @cluster_name
end

#cluster_uuid ⇒ String

Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster. Corresponds to the JSON property clusterUuid

Returns:

  • (String) 


373
374
375
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 373

def cluster_uuid
  @cluster_uuid
end

#config ⇒ Google::Apis::DataprocV1::ClusterConfig

The cluster config. Corresponds to the JSON property config

Returns:



361
362
363
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 361

def config
  @config
end

#labels ⇒ Hash<String,String>

Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/ rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt) . No more than 32 labels can be associated with a cluster. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


339
340
341
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 339

def labels
  @labels
end

#metrics ⇒ Google::Apis::DataprocV1::ClusterMetrics

Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. Corresponds to the JSON property metrics

Returns:



346
347
348
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 346

def metrics
  @metrics
end

#project_id ⇒ String

Required. The Google Cloud Platform project ID that the cluster belongs to. Corresponds to the JSON property projectId

Returns:

  • (String) 


378
379
380
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 378

def project_id
  @project_id
end

#status ⇒ Google::Apis::DataprocV1::ClusterStatus

The status of a cluster and its instances. Corresponds to the JSON property status

Returns:



351
352
353
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 351

def status
  @status
end

#status_history ⇒ Array<Google::Apis::DataprocV1::ClusterStatus>

Output-only. The previous cluster status. Corresponds to the JSON property statusHistory

Returns:



356
357
358
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 356

def status_history
  @status_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



385
386
387
388
389
390
391
392
393
394
 
# File 'generated/google/apis/dataproc_v1/classes.rb', line 385

def update!(**args)
  @labels = args[:labels] if args.key?(:labels)
  @metrics = args[:metrics] if args.key?(:metrics)
  @status = args[:status] if args.key?(:status)
  @status_history = args[:status_history] if args.key?(:status_history)
  @config = args[:config] if args.key?(:config)
  @cluster_name = args[:cluster_name] if args.key?(:cluster_name)
  @cluster_uuid = args[:cluster_uuid] if args.key?(:cluster_uuid)
  @project_id = args[:project_id] if args.key?(:project_id)
end