com.google.cloud.dataproc.v1

Class Cluster

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dataproc.v1.Cluster

All Implemented Interfaces:

ClusterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Cluster
extends com.google.protobuf.GeneratedMessageV3
implements ClusterOrBuilder

 Describes the identifying information, config, and status of
 a cluster of Compute Engine instances.
 

Protobuf type google.cloud.dataproc.v1.Cluster

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.Builder Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLUSTER_NAME_FIELD_NUMBER
static int	CLUSTER_UUID_FIELD_NUMBER
static int	CONFIG_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	METRICS_FIELD_NUMBER
static int	PROJECT_ID_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	STATUS_HISTORY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
boolean	equals(Object obj)
String	getClusterName() Required.
com.google.protobuf.ByteString	getClusterNameBytes() Required.
String	getClusterUuid() Output only.
com.google.protobuf.ByteString	getClusterUuidBytes() Output only.
ClusterConfig	getConfig() Required.
ClusterConfigOrBuilder	getConfigOrBuilder() Required.
static Cluster	getDefaultInstance()
Cluster	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
ClusterMetrics	getMetrics() Contains cluster daemon metrics such as HDFS and YARN stats.
ClusterMetricsOrBuilder	getMetricsOrBuilder() Contains cluster daemon metrics such as HDFS and YARN stats.
com.google.protobuf.Parser<Cluster>	getParserForType()
String	getProjectId() Required.
com.google.protobuf.ByteString	getProjectIdBytes() Required.
int	getSerializedSize()
ClusterStatus	getStatus() Output only.
ClusterStatus	getStatusHistory(int index) Output only.
int	getStatusHistoryCount() Output only.
List<ClusterStatus>	getStatusHistoryList() Output only.
ClusterStatusOrBuilder	getStatusHistoryOrBuilder(int index) Output only.
List<? extends ClusterStatusOrBuilder>	getStatusHistoryOrBuilderList() Output only.
ClusterStatusOrBuilder	getStatusOrBuilder() Output only.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasConfig() Required.
int	hashCode()
boolean	hasMetrics() Contains cluster daemon metrics such as HDFS and YARN stats.
boolean	hasStatus() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Cluster.Builder	newBuilder()
static Cluster.Builder	newBuilder(Cluster prototype)
Cluster.Builder	newBuilderForType()
protected Cluster.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Cluster	parseDelimitedFrom(InputStream input)
static Cluster	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster	parseFrom(byte[] data)
static Cluster	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster	parseFrom(ByteBuffer data)
static Cluster	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster	parseFrom(com.google.protobuf.ByteString data)
static Cluster	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster	parseFrom(com.google.protobuf.CodedInputStream input)
static Cluster	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Cluster	parseFrom(InputStream input)
static Cluster	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Cluster>	parser()
Cluster.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_NAME_FIELD_NUMBER

public static final int CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONFIG_FIELD_NUMBER

public static final int CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_HISTORY_FIELD_NUMBER

public static final int STATUS_HISTORY_FIELD_NUMBER

See Also:

Constant Field Values

CLUSTER_UUID_FIELD_NUMBER

public static final int CLUSTER_UUID_FIELD_NUMBER

See Also:

Constant Field Values

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProjectId

public String getProjectId()

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

string project_id = 1;

Specified by:

getProjectId in interface ClusterOrBuilder

getProjectIdBytes

public com.google.protobuf.ByteString getProjectIdBytes()

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

string project_id = 1;

Specified by:

getProjectIdBytes in interface ClusterOrBuilder

getClusterName

public 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;

Specified by:

getClusterName in interface ClusterOrBuilder

getClusterNameBytes

public com.google.protobuf.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;

Specified by:

getClusterNameBytes in interface ClusterOrBuilder

hasConfig

public boolean hasConfig()

 Required. The cluster config. Note that Cloud Dataproc may set
 default values, and values may change when clusters are updated.
 

.google.cloud.dataproc.v1.ClusterConfig config = 3;

Specified by:

hasConfig in interface ClusterOrBuilder

getConfig

public ClusterConfig getConfig()

 Required. The cluster config. Note that Cloud Dataproc may set
 default values, and values may change when clusters are updated.
 

.google.cloud.dataproc.v1.ClusterConfig config = 3;

Specified by:

getConfig in interface ClusterOrBuilder

getConfigOrBuilder

public ClusterConfigOrBuilder getConfigOrBuilder()

 Required. The cluster config. Note that Cloud Dataproc may set
 default values, and values may change when clusters are updated.
 

.google.cloud.dataproc.v1.ClusterConfig config = 3;

Specified by:

getConfigOrBuilder in interface ClusterOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: ClusterOrBuilder

 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.
 

map<string, string> labels = 8;

Specified by:

getLabelsCount in interface ClusterOrBuilder

containsLabels

public 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](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.
 

map<string, string> labels = 8;

Specified by:

containsLabels in interface ClusterOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface ClusterOrBuilder

getLabelsMap

public 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](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.
 

map<string, string> labels = 8;

Specified by:

getLabelsMap in interface ClusterOrBuilder

getLabelsOrDefault

public 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](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.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrDefault in interface ClusterOrBuilder

getLabelsOrThrow

public 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](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.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrThrow in interface ClusterOrBuilder

hasStatus

public boolean hasStatus()

 Output only. Cluster status.
 

.google.cloud.dataproc.v1.ClusterStatus status = 4;

Specified by:

hasStatus in interface ClusterOrBuilder

getStatus

public ClusterStatus getStatus()

 Output only. Cluster status.
 

.google.cloud.dataproc.v1.ClusterStatus status = 4;

Specified by:

getStatus in interface ClusterOrBuilder

getStatusOrBuilder

public ClusterStatusOrBuilder getStatusOrBuilder()

 Output only. Cluster status.
 

.google.cloud.dataproc.v1.ClusterStatus status = 4;

Specified by:

getStatusOrBuilder in interface ClusterOrBuilder

getStatusHistoryList

public List<ClusterStatus> getStatusHistoryList()

 Output only. The previous cluster status.
 

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;

Specified by:

getStatusHistoryList in interface ClusterOrBuilder

getStatusHistoryOrBuilderList

public List<? extends ClusterStatusOrBuilder> getStatusHistoryOrBuilderList()

 Output only. The previous cluster status.
 

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;

Specified by:

getStatusHistoryOrBuilderList in interface ClusterOrBuilder

getStatusHistoryCount

public int getStatusHistoryCount()

 Output only. The previous cluster status.
 

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;

Specified by:

getStatusHistoryCount in interface ClusterOrBuilder

getStatusHistory

public ClusterStatus getStatusHistory(int index)

 Output only. The previous cluster status.
 

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;

Specified by:

getStatusHistory in interface ClusterOrBuilder

getStatusHistoryOrBuilder

public ClusterStatusOrBuilder getStatusHistoryOrBuilder(int index)

 Output only. The previous cluster status.
 

repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7;

Specified by:

getStatusHistoryOrBuilder in interface ClusterOrBuilder

getClusterUuid

public String getClusterUuid()

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

string cluster_uuid = 6;

Specified by:

getClusterUuid in interface ClusterOrBuilder

getClusterUuidBytes

public com.google.protobuf.ByteString getClusterUuidBytes()

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

string cluster_uuid = 6;

Specified by:

getClusterUuidBytes in interface ClusterOrBuilder

hasMetrics

public boolean hasMetrics()

 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;

Specified by:

hasMetrics in interface ClusterOrBuilder

getMetrics

public ClusterMetrics getMetrics()

 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;

Specified by:

getMetrics in interface ClusterOrBuilder

getMetricsOrBuilder

public ClusterMetricsOrBuilder getMetricsOrBuilder()

 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;

Specified by:

getMetricsOrBuilder in interface ClusterOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Cluster parseFrom(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Cluster parseFrom(InputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Cluster parseFrom(InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster parseDelimitedFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Cluster parseDelimitedFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseFrom

public static Cluster parseFrom(com.google.protobuf.CodedInputStream input)
                         throws IOException

Throws:

IOException

parseFrom

public static Cluster parseFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Throws:

IOException

newBuilderForType

public Cluster.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Cluster.Builder newBuilder()

newBuilder

public static Cluster.Builder newBuilder(Cluster prototype)

toBuilder

public Cluster.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Cluster.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Cluster getDefaultInstance()

parser

public static com.google.protobuf.Parser<Cluster> parser()

getParserForType

public com.google.protobuf.Parser<Cluster> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Cluster getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder