Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::Cluster (v0.17.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::Cluster.

Describes the identifying information, config, and status of a Dataproc cluster

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cluster_name

def cluster_name() -> ::String
Returns
  • (::String) — Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.

#cluster_name=

def cluster_name=(value) -> ::String
Parameter
  • value (::String) — Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.
Returns
  • (::String) — Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.

#cluster_uuid

def cluster_uuid() -> ::String
Returns
  • (::String) — Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

#config

def config() -> ::Google::Cloud::Dataproc::V1::ClusterConfig
Returns
  • (::Google::Cloud::Dataproc::V1::ClusterConfig) — Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.

    Exactly one of ClusterConfig or VirtualClusterConfig must be specified.

#config=

def config=(value) -> ::Google::Cloud::Dataproc::V1::ClusterConfig
Parameter
  • value (::Google::Cloud::Dataproc::V1::ClusterConfig) — Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.

    Exactly one of ClusterConfig or VirtualClusterConfig must be specified.

Returns
  • (::Google::Cloud::Dataproc::V1::ClusterConfig) — Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.

    Exactly one of ClusterConfig or VirtualClusterConfig must be specified.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster.

#metrics

def metrics() -> ::Google::Cloud::Dataproc::V1::ClusterMetrics
Returns
  • (::Google::Cloud::Dataproc::V1::ClusterMetrics) — Output only. 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.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The Google Cloud Platform project ID that the cluster belongs to.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The Google Cloud Platform project ID that the cluster belongs to.
Returns
  • (::String) — Required. The Google Cloud Platform project ID that the cluster belongs to.

#status

def status() -> ::Google::Cloud::Dataproc::V1::ClusterStatus
Returns

#status_history

def status_history() -> ::Array<::Google::Cloud::Dataproc::V1::ClusterStatus>
Returns

#virtual_cluster_config

def virtual_cluster_config() -> ::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Returns

#virtual_cluster_config=

def virtual_cluster_config=(value) -> ::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Parameter
Returns