com.google.cloud.dataproc.v1

Interface BatchOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Batch, Batch.Builder

public interface BatchOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
Batch.BatchConfigCase	getBatchConfigCase()
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getCreator() Output only.
ByteString	getCreatorBytes() Output only.
EnvironmentConfig	getEnvironmentConfig() Optional.
EnvironmentConfigOrBuilder	getEnvironmentConfigOrBuilder() Optional.
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.
String	getName() Output only.
ByteString	getNameBytes() Output only.
String	getOperation() Output only.
ByteString	getOperationBytes() Output only.
PySparkBatch	getPysparkBatch() Optional.
PySparkBatchOrBuilder	getPysparkBatchOrBuilder() Optional.
RuntimeConfig	getRuntimeConfig() Optional.
RuntimeConfigOrBuilder	getRuntimeConfigOrBuilder() Optional.
RuntimeInfo	getRuntimeInfo() Output only.
RuntimeInfoOrBuilder	getRuntimeInfoOrBuilder() Output only.
SparkBatch	getSparkBatch() Optional.
SparkBatchOrBuilder	getSparkBatchOrBuilder() Optional.
SparkRBatch	getSparkRBatch() Optional.
SparkRBatchOrBuilder	getSparkRBatchOrBuilder() Optional.
SparkSqlBatch	getSparkSqlBatch() Optional.
SparkSqlBatchOrBuilder	getSparkSqlBatchOrBuilder() Optional.
Batch.State	getState() Output only.
Batch.StateHistory	getStateHistory(int index) Output only.
int	getStateHistoryCount() Output only.
List<Batch.StateHistory>	getStateHistoryList() Output only.
Batch.StateHistoryOrBuilder	getStateHistoryOrBuilder(int index) Output only.
List<? extends Batch.StateHistoryOrBuilder>	getStateHistoryOrBuilderList() Output only.
String	getStateMessage() Output only.
ByteString	getStateMessageBytes() Output only.
Timestamp	getStateTime() Output only.
TimestampOrBuilder	getStateTimeOrBuilder() Output only.
int	getStateValue() Output only.
String	getUuid() Output only.
ByteString	getUuidBytes() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEnvironmentConfig() Optional.
boolean	hasPysparkBatch() Optional.
boolean	hasRuntimeConfig() Optional.
boolean	hasRuntimeInfo() Output only.
boolean	hasSparkBatch() Optional.
boolean	hasSparkRBatch() Optional.
boolean	hasSparkSqlBatch() Optional.
boolean	hasStateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. The resource name of the batch.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

ByteString getNameBytes()

 Output only. The resource name of the batch.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getUuid

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];

Returns:

The uuid.

getUuidBytes

ByteString getUuidBytes()

 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];

Returns:

The bytes for uuid.

hasCreateTime

boolean hasCreateTime()

 Output only. The time when the batch was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

Timestamp getCreateTime()

 Output only. The time when the batch was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time when the batch was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasPysparkBatch

boolean hasPysparkBatch()

 Optional. PySpark batch config.
 

.google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the pysparkBatch field is set.

getPysparkBatch

PySparkBatch getPysparkBatch()

 Optional. PySpark batch config.
 

.google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pysparkBatch.

getPysparkBatchOrBuilder

PySparkBatchOrBuilder getPysparkBatchOrBuilder()

 Optional. PySpark batch config.
 

.google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];

hasSparkBatch

boolean hasSparkBatch()

 Optional. Spark batch config.
 

.google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the sparkBatch field is set.

getSparkBatch

SparkBatch getSparkBatch()

 Optional. Spark batch config.
 

.google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The sparkBatch.

getSparkBatchOrBuilder

SparkBatchOrBuilder getSparkBatchOrBuilder()

 Optional. Spark batch config.
 

.google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];

hasSparkRBatch

boolean hasSparkRBatch()

 Optional. SparkR batch config.
 

.google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the sparkRBatch field is set.

getSparkRBatch

SparkRBatch getSparkRBatch()

 Optional. SparkR batch config.
 

.google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The sparkRBatch.

getSparkRBatchOrBuilder

SparkRBatchOrBuilder getSparkRBatchOrBuilder()

 Optional. SparkR batch config.
 

.google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];

hasSparkSqlBatch

boolean hasSparkSqlBatch()

 Optional. SparkSql batch config.
 

.google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the sparkSqlBatch field is set.

getSparkSqlBatch

SparkSqlBatch getSparkSqlBatch()

 Optional. SparkSql batch config.
 

.google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The sparkSqlBatch.

getSparkSqlBatchOrBuilder

SparkSqlBatchOrBuilder getSparkSqlBatchOrBuilder()

 Optional. SparkSql batch config.
 

.google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];

hasRuntimeInfo

boolean hasRuntimeInfo()

 Output only. Runtime information about batch execution.
 

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the runtimeInfo field is set.

getRuntimeInfo

RuntimeInfo getRuntimeInfo()

 Output only. Runtime information about batch execution.
 

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The runtimeInfo.

getRuntimeInfoOrBuilder

RuntimeInfoOrBuilder getRuntimeInfoOrBuilder()

 Output only. Runtime information about batch execution.
 

.google.cloud.dataproc.v1.RuntimeInfo runtime_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getStateValue

int getStateValue()

 Output only. The state of the batch.
 

.google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Batch.State getState()

 Output only. The state of the batch.
 

.google.cloud.dataproc.v1.Batch.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getStateMessage

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];

Returns:

The stateMessage.

getStateMessageBytes

ByteString getStateMessageBytes()

 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];

Returns:

The bytes for stateMessage.

hasStateTime

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];

Returns:

Whether the stateTime field is set.

getStateTime

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];

Returns:

The stateTime.

getStateTimeOrBuilder

TimestampOrBuilder getStateTimeOrBuilder()

 Output only. The time when the batch entered a current state.
 

.google.protobuf.Timestamp state_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getCreator

String getCreator()

 Output only. The email address of the user who created the batch.
 

string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The creator.

getCreatorBytes

ByteString getCreatorBytes()

 Output only. The email address of the user who created the batch.
 

string creator = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for creator.

getLabelsCount

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];

containsLabels

boolean containsLabels(String key)

 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];

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

Map<String,String> 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];

getLabelsOrDefault

String getLabelsOrDefault(String key,
                          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];

getLabelsOrThrow

String getLabelsOrThrow(String key)

 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];

hasRuntimeConfig

boolean hasRuntimeConfig()

 Optional. Runtime configuration for the batch execution.
 

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the runtimeConfig field is set.

getRuntimeConfig

RuntimeConfig getRuntimeConfig()

 Optional. Runtime configuration for the batch execution.
 

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The runtimeConfig.

getRuntimeConfigOrBuilder

RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

 Optional. Runtime configuration for the batch execution.
 

.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];

hasEnvironmentConfig

boolean hasEnvironmentConfig()

 Optional. Environment configuration for the batch execution.
 

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the environmentConfig field is set.

getEnvironmentConfig

EnvironmentConfig getEnvironmentConfig()

 Optional. Environment configuration for the batch execution.
 

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The environmentConfig.

getEnvironmentConfigOrBuilder

EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()

 Optional. Environment configuration for the batch execution.
 

.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];

getOperation

String getOperation()

 Output only. The resource name of the operation associated with this batch.
 

string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The operation.

getOperationBytes

ByteString getOperationBytes()

 Output only. The resource name of the operation associated with this batch.
 

string operation = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for operation.

getStateHistoryList

List<Batch.StateHistory> 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];

getStateHistory

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];

getStateHistoryCount

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];

getStateHistoryOrBuilderList

List<? extends Batch.StateHistoryOrBuilder> 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];

getStateHistoryOrBuilder

Batch.StateHistoryOrBuilder getStateHistoryOrBuilder(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];

getBatchConfigCase

Batch.BatchConfigCase getBatchConfigCase()