clusters

Overview

Name	clusters
Type	Resource
Id	google.dataproc.clusters

Fields

Name	Datatype	Description
config	object	The cluster config.
labels	object	Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
status	object	The status of a cluster and its instances.
projectId	string	Required. The Google Cloud Platform project ID that the cluster belongs to.
clusterName	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.
clusterUuid	string	Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
metrics	object	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.
statusHistory	array	Output only. The previous cluster status.
virtualClusterConfig	object	The Dataproc cluster config for a cluster that does not directly control the underlying compute resources, such as a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview).

Methods

Name	Accessible by	Required Params	Description
projects_regions_clusters_get	SELECT	clusterName, projectId, region	Gets the resource representation for a cluster in a project.
projects_regions_clusters_list	SELECT	projectId, region	Lists all regions/{region}/clusters in a project alphabetically.
projects_regions_clusters_create	INSERT	projectId, region	Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
projects_regions_clusters_delete	DELETE	clusterName, projectId, region	Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
_projects_regions_clusters_list	EXEC	projectId, region	Lists all regions/{region}/clusters in a project alphabetically.
projects_regions_clusters_diagnose	EXEC	clusterName, projectId, region	Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).
projects_regions_clusters_inject_credentials	EXEC	clustersId, projectsId, regionsId	Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.
projects_regions_clusters_patch	EXEC	clusterName, projectId, region	Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.
projects_regions_clusters_repair	EXEC	clusterName, projectId, region	Repairs a cluster.
projects_regions_clusters_start	EXEC	clusterName, projectId, region	Starts a cluster in a project.
projects_regions_clusters_stop	EXEC	clusterName, projectId, region	Stops a cluster in a project.