Interface ClusterOrBuilder (4.4.0)

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getClusterName()

public abstract String getClusterName()

Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The clusterName.

getClusterNameBytes()

public abstract ByteString getClusterNameBytes()

Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

string cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for clusterName.

getClusterUuid()

public abstract String getClusterUuid()

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

string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The clusterUuid.

getClusterUuidBytes()

public abstract ByteString getClusterUuidBytes()

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

string cluster_uuid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for clusterUuid.

getConfig()

public abstract 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.

.google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ClusterConfig

The config.

getConfigOrBuilder()

public abstract ClusterConfigOrBuilder getConfigOrBuilder()

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.

.google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ClusterConfigOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMetrics()

public abstract 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.

.google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ClusterMetrics

The metrics.

getMetricsOrBuilder()

public abstract ClusterMetricsOrBuilder getMetricsOrBuilder()

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.

.google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ClusterMetricsOrBuilder

getProjectId()

public abstract String getProjectId()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

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

string project_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for projectId.

getStatus()

public abstract ClusterStatus getStatus()

Output only. Cluster status.

.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ClusterStatus

The status.

getStatusHistory(int index)

public abstract ClusterStatus getStatusHistory(int index)

Output only. The previous cluster status.

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ClusterStatus

getStatusHistoryCount()

public abstract int getStatusHistoryCount()

Output only. The previous cluster status.

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

getStatusHistoryList()

public abstract List<ClusterStatus> getStatusHistoryList()

Output only. The previous cluster status.

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<ClusterStatus>

getStatusHistoryOrBuilder(int index)

public abstract ClusterStatusOrBuilder getStatusHistoryOrBuilder(int index)

Output only. The previous cluster status.

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
indexint
Returns
TypeDescription
ClusterStatusOrBuilder

getStatusHistoryOrBuilderList()

public abstract List<? extends ClusterStatusOrBuilder> getStatusHistoryOrBuilderList()

Output only. The previous cluster status.

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
List<? extends com.google.cloud.dataproc.v1.ClusterStatusOrBuilder>

getStatusOrBuilder()

public abstract ClusterStatusOrBuilder getStatusOrBuilder()

Output only. Cluster status.

.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ClusterStatusOrBuilder

getVirtualClusterConfig()

public abstract VirtualClusterConfig 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.

.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
VirtualClusterConfig

The virtualClusterConfig.

getVirtualClusterConfigOrBuilder()

public abstract VirtualClusterConfigOrBuilder getVirtualClusterConfigOrBuilder()

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.

.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
VirtualClusterConfigOrBuilder

hasConfig()

public abstract boolean hasConfig()

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.

.google.cloud.dataproc.v1.ClusterConfig config = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the config field is set.

hasMetrics()

public abstract boolean hasMetrics()

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.

.google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the metrics field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. Cluster status.

.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the status field is set.

hasVirtualClusterConfig()

public abstract boolean hasVirtualClusterConfig()

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.

.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the virtualClusterConfig field is set.