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.
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
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.
↳ virtual_cluster_config
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.
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. The labels to associate with this cluster. Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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
↳ status_history
↳ 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.
string
setProjectId
Required. The Google Cloud Platform project ID that the cluster belongs to.
var
string
$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.
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.
var
string
$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.
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.
$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.
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.
$this
getLabels
Optional. The labels to associate with this cluster.
Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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.
setLabels
Optional. The labels to associate with this cluster.
Label keysmust contain 1 to 63 characters, and must conform to RFC 1035 . Label valuesmay 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.
$this
getStatus
Output only. Cluster status.
hasStatus
clearStatus
setStatus
Output only. Cluster status.
$this
getStatusHistory
Output only. The previous cluster status.
setStatusHistory
Output only. The previous cluster status.
$this
getClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
string
setClusterUuid
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
var
string
$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.
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.
$this
