/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dataproc/v1/clusters.proto
package com.google.cloud.dataproc.v1;
public interface ClusterOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.Cluster)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The Google Cloud Platform project ID that the cluster belongs to.
*
*
* string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The projectId.
*/
java.lang.String getProjectId();
/**
*
*
*
* Required. The Google Cloud Platform project ID that the cluster belongs to.
*
*
* string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for projectId.
*/
com.google.protobuf.ByteString getProjectIdBytes();
/**
*
*
*
* 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];
*
* @return The clusterName.
*/
java.lang.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];
*
* @return The bytes for clusterName.
*/
com.google.protobuf.ByteString getClusterNameBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the config field is set.
*/
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];
*
*
* @return The config.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.ClusterConfigOrBuilder getConfigOrBuilder();
/**
*
*
*
* 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];
*
*
* @return Whether the virtualClusterConfig field is set.
*/
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];
*
*
* @return The virtualClusterConfig.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.VirtualClusterConfigOrBuilder getVirtualClusterConfigOrBuilder();
/**
*
*
*
* 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];
*/
int getLabelsCount();
/**
*
*
*
* 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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. Cluster status.
*
*
*
* .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the status field is set.
*/
boolean hasStatus();
/**
*
*
*
* Output only. Cluster status.
*
*
*
* .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The status.
*/
com.google.cloud.dataproc.v1.ClusterStatus getStatus();
/**
*
*
*
* Output only. Cluster status.
*
*
*
* .google.cloud.dataproc.v1.ClusterStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.ClusterStatusOrBuilder getStatusOrBuilder();
/**
*
*
*
* Output only. The previous cluster status.
*
*
*
* repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getStatusHistoryList();
/**
*
*
*
* Output only. The previous cluster status.
*
*
*
* repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.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];
*
*/
int getStatusHistoryCount();
/**
*
*
*
* Output only. The previous cluster status.
*
*
*
* repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getStatusHistoryOrBuilderList();
/**
*
*
*
* Output only. The previous cluster status.
*
*
*
* repeated .google.cloud.dataproc.v1.ClusterStatus status_history = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.ClusterStatusOrBuilder getStatusHistoryOrBuilder(int index);
/**
*
*
*
* 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];
*
* @return The clusterUuid.
*/
java.lang.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];
*
* @return The bytes for clusterUuid.
*/
com.google.protobuf.ByteString getClusterUuidBytes();
/**
*
*
*
* 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];
*
*
* @return Whether the metrics field is set.
*/
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];
*
*
* @return The metrics.
*/
com.google.cloud.dataproc.v1.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];
*
*/
com.google.cloud.dataproc.v1.ClusterMetricsOrBuilder getMetricsOrBuilder();
}