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
Methods
__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. Cluster names within a project must be unique. Names of deleted clusters can be reused. |
↳ config |
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. |
↳ virtual_cluster_config |
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. |
↳ 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 |
Google\Cloud\Dataproc\V1\ClusterStatus
Output only. Cluster status. |
↳ status_history |
array<Google\Cloud\Dataproc\V1\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 |
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. |
getProjectId
Required. The Google Cloud Platform project ID that the cluster belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The Google Cloud Platform project ID that the cluster belongs to.
Generated from protobuf field string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterName
Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Generated from protobuf field string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterName
Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Generated from protobuf field string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\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.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\ClusterConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVirtualClusterConfig
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.
Generated from protobuf field .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\VirtualClusterConfig|null | |
hasVirtualClusterConfig
clearVirtualClusterConfig
setVirtualClusterConfig
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.
Generated from protobuf field .google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\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.
Generated from protobuf field map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Output only. Cluster status.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\ClusterStatus|null | |
hasStatus
clearStatus
setStatus
Output only. Cluster status.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\ClusterStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusHistory
Output only. The previous cluster status.
Generated from protobuf field repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setStatusHistory
Output only. The previous cluster status.
Generated from protobuf field repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataproc\V1\ClusterStatus>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Generated from protobuf field string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Generated from protobuf field string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataproc\V1\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.
Generated from protobuf field .google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataproc\V1\ClusterMetrics
|
| Returns | |
|---|---|
| Type | Description |
$this | |