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 Dataproc cluster
 
```
Protobuf type google.cloud.dataproc.v1.Cluster
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Cluster.Builder
Describes the identifying information, config, and status of a Dataproc cluster
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	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`
`static int`	`VIRTUAL_CLUSTER_CONFIG_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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	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()`	Optional.
`ClusterConfigOrBuilder`	`getConfigOrBuilder()`	Optional.
`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()`	Output only.
`ClusterMetricsOrBuilder`	`getMetricsOrBuilder()`	Output only.
`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.
`VirtualClusterConfig`	`getVirtualClusterConfig()`	Optional.
`VirtualClusterConfigOrBuilder`	`getVirtualClusterConfigOrBuilder()`	Optional.
`boolean`	`hasConfig()`	Optional.
`int`	`hashCode()`
`boolean`	`hasMetrics()`	Output only.
`boolean`	`hasStatus()`	Output only.
`boolean`	`hasVirtualClusterConfig()`	Optional.
`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)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`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(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 Cluster`	`parseFrom(ByteBuffer data)`
`static Cluster`	`parseFrom(ByteBuffer data, 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, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, 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.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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
- VIRTUAL_CLUSTER_CONFIG_FIELD_NUMBER
```
public static final int VIRTUAL_CLUSTER_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

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance 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 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getProjectId in interface ClusterOrBuilder

Returns:

The projectId.

getProjectIdBytes
```
public com.google.protobuf.ByteString getProjectIdBytes()
```
```
 Required. The Google Cloud Platform project ID that the cluster belongs to.
 
```
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getProjectIdBytes in interface ClusterOrBuilder

Returns:

The bytes for projectId.

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.

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

Specified by:: getClusterName in interface ClusterOrBuilder
Returns:: The clusterName.

getClusterNameBytes

public com.google.protobuf.ByteString getClusterNameBytes()

 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 cluster_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getClusterNameBytes in interface ClusterOrBuilder
Returns:: The bytes for clusterName.

hasConfig

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

 Exactly one of ClusterConfig or VirtualClusterConfig must be specified.


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

Specified by:: hasConfig in interface ClusterOrBuilder
Returns:: Whether the config field is set.

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.


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

Specified by:: getConfig in interface ClusterOrBuilder
Returns:: The config.

getConfigOrBuilder

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

 Exactly one of ClusterConfig or VirtualClusterConfig must be specified.


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

Specified by:: getConfigOrBuilder in interface ClusterOrBuilder

hasVirtualClusterConfig

public boolean hasVirtualClusterConfig()

 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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.


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

Specified by:: hasVirtualClusterConfig in interface ClusterOrBuilder
Returns:: Whether the virtualClusterConfig field is set.

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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.


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

Specified by:: getVirtualClusterConfig in interface ClusterOrBuilder
Returns:: The virtualClusterConfig.

getVirtualClusterConfigOrBuilder

public VirtualClusterConfigOrBuilder getVirtualClusterConfigOrBuilder()

 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][google.cloud.dataproc.v1.Cluster.config] or
 [virtual_cluster_config][google.cloud.dataproc.v1.Cluster.virtual_cluster_config]
 must be specified.


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

Specified by:: getVirtualClusterConfigOrBuilder in interface ClusterOrBuilder