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 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.


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

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

Instance Attribute Details

#cluster_nameString

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)

323
324
325
# File 'generated/google/apis/dataproc_v1/classes.rb', line 323

def cluster_name
  @cluster_name
end

#cluster_uuidString

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

Returns:

  • (String)

329
330
331
# File 'generated/google/apis/dataproc_v1/classes.rb', line 329

def cluster_uuid
  @cluster_uuid
end

#configGoogle::Apis::DataprocV1::ClusterConfig

The cluster config. Corresponds to the JSON property config


334
335
336
# File 'generated/google/apis/dataproc_v1/classes.rb', line 334

def config
  @config
end

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

343
344
345
# File 'generated/google/apis/dataproc_v1/classes.rb', line 343

def labels
  @labels
end

#metricsGoogle::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


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

def metrics
  @metrics
end

#project_idString

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

Returns:

  • (String)

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

def project_id
  @project_id
end

#statusGoogle::Apis::DataprocV1::ClusterStatus

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


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

def status
  @status
end

#status_historyArray<Google::Apis::DataprocV1::ClusterStatus>

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


365
366
367
# File 'generated/google/apis/dataproc_v1/classes.rb', line 365

def status_history
  @status_history
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


372
373
374
375
376
377
378
379
380
381
# File 'generated/google/apis/dataproc_v1/classes.rb', line 372

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