/*
* 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/batches.proto
package com.google.cloud.dataproc.v1;
public interface BatchOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.Batch)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name of the batch.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name of the batch.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. A batch UUID (Unique Universal Identifier). The service
* generates this value when it creates the batch.
*
*
* string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uuid.
*/
java.lang.String getUuid();
/**
*
*
*
* Output only. A batch UUID (Unique Universal Identifier). The service
* generates this value when it creates the batch.
*
*
* string uuid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uuid.
*/
com.google.protobuf.ByteString getUuidBytes();
/**
*
*
*
* Output only. The time when the batch was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the batch was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the batch was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Optional. PySpark batch config.
*
*
*
* .google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the pysparkBatch field is set.
*/
boolean hasPysparkBatch();
/**
*
*
*
* Optional. PySpark batch config.
*
*
*
* .google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The pysparkBatch.
*/
com.google.cloud.dataproc.v1.PySparkBatch getPysparkBatch();
/**
*
*
*
* Optional. PySpark batch config.
*
*
*
* .google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.PySparkBatchOrBuilder getPysparkBatchOrBuilder();
/**
*
*
*
* Optional. Spark batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkBatch field is set.
*/
boolean hasSparkBatch();
/**
*
*
*
* Optional. Spark batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkBatch.
*/
com.google.cloud.dataproc.v1.SparkBatch getSparkBatch();
/**
*
*
*
* Optional. Spark batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkBatchOrBuilder getSparkBatchOrBuilder();
/**
*
*
*
* Optional. SparkR batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkRBatch field is set.
*/
boolean hasSparkRBatch();
/**
*
*
*
* Optional. SparkR batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkRBatch.
*/
com.google.cloud.dataproc.v1.SparkRBatch getSparkRBatch();
/**
*
*
*
* Optional. SparkR batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkRBatchOrBuilder getSparkRBatchOrBuilder();
/**
*
*
*
* Optional. SparkSql batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the sparkSqlBatch field is set.
*/
boolean hasSparkSqlBatch();
/**
*
*
*
* Optional. SparkSql batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The sparkSqlBatch.
*/
com.google.cloud.dataproc.v1.SparkSqlBatch getSparkSqlBatch();
/**
*
*
*
* Optional. SparkSql batch config.
*
*
*
* .google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.SparkSqlBatchOrBuilder getSparkSqlBatchOrBuilder();
/**
*
*
*
* Output only. Runtime information about batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the runtimeInfo field is set.
*/
boolean hasRuntimeInfo();
/**
*
*
*
* Output only. Runtime information about batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The runtimeInfo.
*/
com.google.cloud.dataproc.v1.RuntimeInfo getRuntimeInfo();
/**
*
*
*
* Output only. Runtime information about batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.RuntimeInfoOrBuilder getRuntimeInfoOrBuilder();
/**
*
*
*
* Output only. The state of the batch.
*
*
*
* .google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The state of the batch.
*
*
*
* .google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.dataproc.v1.Batch.State getState();
/**
*
*
*
* Output only. Batch state details, such as a failure
* description if the state is `FAILED`.
*
*
* string state_message = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The stateMessage.
*/
java.lang.String getStateMessage();
/**
*
*
*
* Output only. Batch state details, such as a failure
* description if the state is `FAILED`.
*
*
* string state_message = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for stateMessage.
*/
com.google.protobuf.ByteString getStateMessageBytes();
/**
*
*
*
* Output only. The time when the batch entered a current state.
*
*
* .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the stateTime field is set.
*/
boolean hasStateTime();
/**
*
*
*
* Output only. The time when the batch entered a current state.
*
*
* .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The stateTime.
*/
com.google.protobuf.Timestamp getStateTime();
/**
*
*
*
* Output only. The time when the batch entered a current state.
*
*
* .google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getStateTimeOrBuilder();
/**
*
*
*
* Output only. The email address of the user who created the batch.
*
*
* string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The creator.
*/
java.lang.String getCreator();
/**
*
*
*
* Output only. The email address of the user who created the batch.
*
*
* string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for creator.
*/
com.google.protobuf.ByteString getCreatorBytes();
/**
*
*
*
* Optional. The labels to associate with this batch.
* 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 batch.
*
*
* map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. The labels to associate with this batch.
* 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 batch.
*
*
* map<string, string> labels = 13 [(.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 batch.
* 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 batch.
*
*
* map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. The labels to associate with this batch.
* 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 batch.
*
*
* map<string, string> labels = 13 [(.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 batch.
* 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 batch.
*
*
* map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Runtime configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the runtimeConfig field is set.
*/
boolean hasRuntimeConfig();
/**
*
*
*
* Optional. Runtime configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The runtimeConfig.
*/
com.google.cloud.dataproc.v1.RuntimeConfig getRuntimeConfig();
/**
*
*
*
* Optional. Runtime configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.RuntimeConfigOrBuilder getRuntimeConfigOrBuilder();
/**
*
*
*
* Optional. Environment configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the environmentConfig field is set.
*/
boolean hasEnvironmentConfig();
/**
*
*
*
* Optional. Environment configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The environmentConfig.
*/
com.google.cloud.dataproc.v1.EnvironmentConfig getEnvironmentConfig();
/**
*
*
*
* Optional. Environment configuration for the batch execution.
*
*
*
* .google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloud.dataproc.v1.EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder();
/**
*
*
*
* Output only. The resource name of the operation associated with this batch.
*
*
* string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The operation.
*/
java.lang.String getOperation();
/**
*
*
*
* Output only. The resource name of the operation associated with this batch.
*
*
* string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for operation.
*/
com.google.protobuf.ByteString getOperationBytes();
/**
*
*
*
* Output only. Historical state information for the batch.
*
*
*
* repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List getStateHistoryList();
/**
*
*
*
* Output only. Historical state information for the batch.
*
*
*
* repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.Batch.StateHistory getStateHistory(int index);
/**
*
*
*
* Output only. Historical state information for the batch.
*
*
*
* repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getStateHistoryCount();
/**
*
*
*
* Output only. Historical state information for the batch.
*
*
*
* repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.List
getStateHistoryOrBuilderList();
/**
*
*
*
* Output only. Historical state information for the batch.
*
*
*
* repeated .google.cloud.dataproc.v1.Batch.StateHistory state_history = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataproc.v1.Batch.StateHistoryOrBuilder getStateHistoryOrBuilder(int index);
public com.google.cloud.dataproc.v1.Batch.BatchConfigCase getBatchConfigCase();
}