Reference documentation and code samples for the Google Cloud Dataproc V1 Client class Cluster.
Describes the identifying information, config, and status of a Dataproc cluster
Generated from protobuf message google.cloud.dataproc.v1.Cluster
Namespace
Google \ Cloud \ Dataproc \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The Google Cloud Platform project ID that the cluster belongs to. |
↳ cluster_name |
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. |
↳ config |
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. |
↳ virtual_cluster_config |
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. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ status |
ClusterStatus
Output only. Cluster status. |
↳ status_history |
array<ClusterStatus>
Output only. The previous cluster status. |
↳ cluster_uuid |
string
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. |
↳ metrics |
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. |
getProjectId
Required. The Google Cloud Platform project ID that the cluster belongs to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
Required. The Google Cloud Platform project ID that the cluster belongs to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClusterName
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 | |
|---|---|
| Type | Description |
string |
|
setClusterName
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfig
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 | |
|---|---|
| Type | Description |
ClusterConfig|null |
|
hasConfig
clearConfig
setConfig
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.
| Parameter | |
|---|---|
| Name | Description |
var |
ClusterConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVirtualClusterConfig
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 | |
|---|---|
| Type | Description |
VirtualClusterConfig|null |
|
hasVirtualClusterConfig
clearVirtualClusterConfig
setVirtualClusterConfig
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.
| Parameter | |
|---|---|
| Name | Description |
var |
VirtualClusterConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
Output only. Cluster status.
| Returns | |
|---|---|
| Type | Description |
ClusterStatus|null |
|
hasStatus
clearStatus
setStatus
Output only. Cluster status.
| Parameter | |
|---|---|
| Name | Description |
var |
ClusterStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatusHistory
Output only. The previous cluster status.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStatusHistory
Output only. The previous cluster status.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ClusterStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetrics
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.
| Returns | |
|---|---|
| Type | Description |
ClusterMetrics|null |
|
hasMetrics
clearMetrics
setMetrics
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.
| Parameter | |
|---|---|
| Name | Description |
var |
ClusterMetrics
|
| Returns | |
|---|---|
| Type | Description |
$this |
|