public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilder
Describes the identifying information, config, and status of
a Dataproc cluster
Protobuf type google.cloud.dataproc.v1.Cluster
Static Fields
CLUSTER_NAME_FIELD_NUMBER
public static final int CLUSTER_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CLUSTER_UUID_FIELD_NUMBER
public static final int CLUSTER_UUID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONFIG_FIELD_NUMBER
public static final int CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATUS_FIELD_NUMBER
public static final int STATUS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATUS_HISTORY_FIELD_NUMBER
public static final int STATUS_HISTORY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VIRTUAL_CLUSTER_CONFIG_FIELD_NUMBER
public static final int VIRTUAL_CLUSTER_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Cluster getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Cluster.Builder newBuilder()
newBuilder(Cluster prototype)
public static Cluster.Builder newBuilder(Cluster prototype)
| Parameter |
|---|
| Name | Description |
prototype | Cluster
|
public static Cluster parseDelimitedFrom(InputStream input)
public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Cluster parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Cluster parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(CodedInputStream input)
public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(InputStream input)
public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Cluster parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Cluster> parser()
Methods
containsLabels(String key)
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.
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
| Returns |
|---|
| Type | Description |
String | The clusterName.
|
getClusterNameBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for clusterName.
|
getClusterUuid()
public 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 |
|---|
| Type | Description |
String | The clusterUuid.
|
getClusterUuidBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for clusterUuid.
|
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];
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];
getDefaultInstanceForType()
public Cluster getDefaultInstanceForType()
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public 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 |
|---|
| Type | Description |
int | |
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.
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];
getLabelsOrDefault(String key, String defaultValue)
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.
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];
getLabelsOrThrow(String key)
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.
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 |
|---|
| Name | Description |
key | String
|
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.
.google.cloud.dataproc.v1.ClusterMetrics metrics = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getMetricsOrBuilder()
public 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];
getParserForType()
public Parser<Cluster> getParserForType()
Overrides
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];
| Returns |
|---|
| Type | Description |
String | The projectId.
|
getProjectIdBytes()
public ByteString getProjectIdBytes()
Required. The Google Cloud Platform project ID that the cluster belongs to.
string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for projectId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getStatus()
public ClusterStatus getStatus()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusHistory(int index)
public 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 |
|---|
| Name | Description |
index | int
|
getStatusHistoryCount()
public int getStatusHistoryCount()
Output only. The previous cluster status.
repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | |
getStatusHistoryList()
public List<ClusterStatus> getStatusHistoryList()
Output only. The previous cluster status.
repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStatusHistoryOrBuilder(int index)
public 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 |
|---|
| Name | Description |
index | int
|
getStatusHistoryOrBuilderList()
public 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 |
|---|
| Type | Description |
List<? extends com.google.cloud.dataproc.v1.ClusterStatusOrBuilder> | |
getStatusOrBuilder()
public ClusterStatusOrBuilder getStatusOrBuilder()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
Dataproc may set default values, and values may change when
clusters are updated. Exactly one of
config or
virtual_cluster_config
must be specified.
.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
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.
Dataproc may set default values, and values may change when
clusters are updated. Exactly one of
config or
virtual_cluster_config
must be specified.
.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the config field is set.
|
hasMetrics()
public 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 |
|---|
| Type | Description |
boolean | Whether the metrics field is set.
|
hasStatus()
public boolean hasStatus()
Output only. Cluster status.
.google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the status field is set.
|
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.
Dataproc may set default values, and values may change when
clusters are updated. Exactly one of
config or
virtual_cluster_config
must be specified.
.google.cloud.dataproc.v1.VirtualClusterConfig virtual_cluster_config = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the virtualClusterConfig field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Cluster.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Cluster.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
