public final class Cluster extends com.google.protobuf.GeneratedMessageV3 implements ClusterOrBuilder
Describes the identifying information, config, and status of a Dataproc clusterProtobuf type
google.cloud.dataproc.v1.Cluster| Modifier and Type | Class and Description |
|---|---|
static class |
Cluster.Builder
Describes the identifying information, config, and status of
a Dataproc cluster
|
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| 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 |
static int |
VIRTUAL_CLUSTER_CONFIG_FIELD_NUMBER |
| 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()
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.MapFieldReflectionAccessor |
internalGetMapFieldReflection(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(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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PROJECT_ID_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
public static final int VIRTUAL_CLUSTER_CONFIG_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
public static final int STATUS_HISTORY_FIELD_NUMBER
public static final int CLUSTER_UUID_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getProjectId()
Required. The Google Cloud Platform project ID that the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];getProjectId in interface ClusterOrBuilderpublic 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];getProjectIdBytes in interface ClusterOrBuilderpublic 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];getClusterName in interface ClusterOrBuilderpublic 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];getClusterNameBytes in interface ClusterOrBuilderpublic 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];
hasConfig in interface ClusterOrBuilderpublic 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];
getConfig in interface ClusterOrBuilderpublic 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];
getConfigOrBuilder in interface ClusterOrBuilderpublic 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];
hasVirtualClusterConfig in interface ClusterOrBuilderpublic 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];
getVirtualClusterConfig in interface ClusterOrBuilderpublic 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];
getVirtualClusterConfigOrBuilder in interface ClusterOrBuilderpublic int getLabelsCount()
ClusterOrBuilderOptional. 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsCount in interface ClusterOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];containsLabels in interface ClusterOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ClusterOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsMap in interface ClusterOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrDefault in interface ClusterOrBuilderpublic 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 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrThrow in interface ClusterOrBuilderpublic boolean hasStatus()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasStatus in interface ClusterOrBuilderpublic ClusterStatus getStatus()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatus in interface ClusterOrBuilderpublic ClusterStatusOrBuilder getStatusOrBuilder()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusOrBuilder in interface ClusterOrBuilderpublic List<ClusterStatus> getStatusHistoryList()
Output only. The previous cluster status.
repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusHistoryList in interface ClusterOrBuilderpublic 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];
getStatusHistoryOrBuilderList in interface ClusterOrBuilderpublic int getStatusHistoryCount()
Output only. The previous cluster status.
repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusHistoryCount in interface ClusterOrBuilderpublic 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];
getStatusHistory in interface ClusterOrBuilderpublic 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];
getStatusHistoryOrBuilder in interface ClusterOrBuilderpublic 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];getClusterUuid in interface ClusterOrBuilderpublic com.google.protobuf.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];getClusterUuidBytes in interface ClusterOrBuilderpublic 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];
hasMetrics in interface ClusterOrBuilderpublic 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];
getMetrics in interface ClusterOrBuilderpublic 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];
getMetricsOrBuilder in interface ClusterOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Cluster parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Cluster parseFrom(InputStream input) throws IOException
IOExceptionpublic static Cluster parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Cluster parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Cluster parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Cluster parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Cluster parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Cluster.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Cluster.Builder newBuilder()
public static Cluster.Builder newBuilder(Cluster prototype)
public Cluster.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Cluster.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Cluster getDefaultInstance()
public static com.google.protobuf.Parser<Cluster> parser()
public com.google.protobuf.Parser<Cluster> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Cluster getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.