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. Cluster names within a project must be unique. Names of deleted clusters can be reused.
#cluster_name=
def cluster_name=(value) -> ::String
Parameter
- value (::String) — Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Returns
- (::String) — Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters 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.
#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.
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.
#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
- (::Google::Cloud::Dataproc::V1::ClusterStatus) — Output only. Cluster status.
#status_history
def status_history() -> ::Array<::Google::Cloud::Dataproc::V1::ClusterStatus>
Returns
- (::Array<::Google::Cloud::Dataproc::V1::ClusterStatus>) — Output only. The previous cluster status.
#virtual_cluster_config
def virtual_cluster_config() -> ::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Returns
- (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config, used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Note that Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtualClusterConfig must be specified.
#virtual_cluster_config=
def virtual_cluster_config=(value) -> ::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Parameter
- value (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config, used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Note that Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtualClusterConfig must be specified.
Returns
- (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config, used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Note that Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtualClusterConfig must be specified.