Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::Cluster (v1.9.0)
Stay organized with collections
Save and categorize content based on your preferences.
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
defcluster_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=
defcluster_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
defcluster_uuid()->::String
Returns
- (::String) — Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
#config
defconfig()->::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=
defconfig=(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
deflabels()->::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=
deflabels=(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
defmetrics()->::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
defproject_id()->::String
Returns
- (::String) — Required. The Google Cloud Platform project ID that the cluster belongs to.
#project_id=
defproject_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
defstatus()->::Google::Cloud::Dataproc::V1::ClusterStatus
Returns
- (::Google::Cloud::Dataproc::V1::ClusterStatus) — Output only. Cluster status.
#status_history
defstatus_history()->::Array<::Google::Cloud::Dataproc::V1::ClusterStatus>
Returns
- (::Array<::Google::Cloud::Dataproc::V1::ClusterStatus>) — Output only. The previous cluster status.
#virtual_cluster_config
defvirtual_cluster_config()->::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Returns
- (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.
#virtual_cluster_config=
defvirtual_cluster_config=(value)->::Google::Cloud::Dataproc::V1::VirtualClusterConfig
Parameter
- value (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.
Returns
- (::Google::Cloud::Dataproc::V1::VirtualClusterConfig) — Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.