com.google.api.services.dataproc.model

Class Cluster

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataproc.model.Cluster

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Cluster
extends com.google.api.client.json.GenericJson

Describes the identifying information, config, and status of a Dataproc cluster

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Cluster()

Method Summary

Modifier and Type	Method and Description
Cluster	clone()
String	getClusterName() Required.
String	getClusterUuid() Output only.
ClusterConfig	getConfig() Optional.
Map<String,String>	getLabels() Optional.
ClusterMetrics	getMetrics() Output only.
String	getProjectId() Required.
ClusterStatus	getStatus() Output only.
List<ClusterStatus>	getStatusHistory() Output only.
VirtualClusterConfig	getVirtualClusterConfig() Optional.
Cluster	set(String fieldName, Object value)
Cluster	setClusterName(String clusterName) Required.
Cluster	setClusterUuid(String clusterUuid) Output only.
Cluster	setConfig(ClusterConfig config) Optional.
Cluster	setLabels(Map<String,String> labels) Optional.
Cluster	setMetrics(ClusterMetrics metrics) Output only.
Cluster	setProjectId(String projectId) Required.
Cluster	setStatus(ClusterStatus status) Output only.
Cluster	setStatusHistory(List<ClusterStatus> statusHistory) Output only.
Cluster	setVirtualClusterConfig(VirtualClusterConfig virtualClusterConfig) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Cluster

public Cluster()

Method Detail

getClusterName

public String 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:

value or null for none

setClusterName

public Cluster setClusterName(String clusterName)

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.

Parameters:

clusterName - clusterName or null for none

getClusterUuid

public String getClusterUuid()

Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

Returns:

value or null for none

setClusterUuid

public Cluster setClusterUuid(String clusterUuid)

Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

Parameters:

clusterUuid - clusterUuid or null for none

getConfig

public ClusterConfig 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:

value or null for none

setConfig

public Cluster setConfig(ClusterConfig config)

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.

Parameters:

config - config or null for none

getLabels

public Map<String,String> getLabels()

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.

Returns:

value or null for none

setLabels

public Cluster setLabels(Map<String,String> labels)

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.

Parameters:

labels - labels or null for none

getMetrics

public ClusterMetrics 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:

value or null for none

setMetrics

public Cluster setMetrics(ClusterMetrics metrics)

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.

Parameters:

metrics - metrics or null for none

getProjectId

public String getProjectId()

Required. The Google Cloud Platform project ID that the cluster belongs to.

Returns:

value or null for none

setProjectId

public Cluster setProjectId(String projectId)

Required. The Google Cloud Platform project ID that the cluster belongs to.

Parameters:

projectId - projectId or null for none

getStatus

public ClusterStatus getStatus()

Output only. Cluster status.

Returns:

value or null for none

setStatus

public Cluster setStatus(ClusterStatus status)

Output only. Cluster status.

Parameters:

status - status or null for none

getStatusHistory

public List<ClusterStatus> getStatusHistory()

Output only. The previous cluster status.

Returns:

value or null for none

setStatusHistory

public Cluster setStatusHistory(List<ClusterStatus> statusHistory)

Output only. The previous cluster status.

Parameters:

statusHistory - statusHistory or null for none

getVirtualClusterConfig

public VirtualClusterConfig 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 (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). 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:

value or null for none

setVirtualClusterConfig

public Cluster setVirtualClusterConfig(VirtualClusterConfig 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 (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.

Parameters:

virtualClusterConfig - virtualClusterConfig or null for none

set

public Cluster set(String fieldName,
                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Cluster clone()

Overrides:

clone in class com.google.api.client.json.GenericJson