Class Batch (4.40.0)

public final class Batch extends GeneratedMessageV3 implements BatchOrBuilder

A representation of a batch workload in the service.

Protobuf type google.cloud.dataproc.v1.Batch

Implements

BatchOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREATOR_FIELD_NUMBER

public static final int CREATOR_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_CONFIG_FIELD_NUMBER

public static final int ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_FIELD_NUMBER

public static final int OPERATION_FIELD_NUMBER
Field Value
Type Description
int

PYSPARK_BATCH_FIELD_NUMBER

public static final int PYSPARK_BATCH_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_CONFIG_FIELD_NUMBER

public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RUNTIME_INFO_FIELD_NUMBER

public static final int RUNTIME_INFO_FIELD_NUMBER
Field Value
Type Description
int

SPARK_BATCH_FIELD_NUMBER

public static final int SPARK_BATCH_FIELD_NUMBER
Field Value
Type Description
int

SPARK_R_BATCH_FIELD_NUMBER

public static final int SPARK_R_BATCH_FIELD_NUMBER
Field Value
Type Description
int

SPARK_SQL_BATCH_FIELD_NUMBER

public static final int SPARK_SQL_BATCH_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATE_HISTORY_FIELD_NUMBER

public static final int STATE_HISTORY_FIELD_NUMBER
Field Value
Type Description
int

STATE_MESSAGE_FIELD_NUMBER

public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

STATE_TIME_FIELD_NUMBER

public static final int STATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

UUID_FIELD_NUMBER

public static final int UUID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Batch getDefaultInstance()
Returns
Type Description
Batch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Batch.Builder newBuilder()
Returns
Type Description
Batch.Builder

newBuilder(Batch prototype)

public static Batch.Builder newBuilder(Batch prototype)
Parameter
Name Description
prototype Batch
Returns
Type Description
Batch.Builder

parseDelimitedFrom(InputStream input)

public static Batch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Batch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Batch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Batch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Batch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Batch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Batch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Batch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Batch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Batch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Batch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Batch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Batch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Batch> parser()
Returns
Type Description
Parser<Batch>

Methods

containsLabels(String key)

public 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. 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 batch.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBatchConfigCase()

public Batch.BatchConfigCase getBatchConfigCase()
Returns
Type Description
Batch.BatchConfigCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the batch was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the batch was created.

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

Returns
Type Description
TimestampOrBuilder

getCreator()

public String getCreator()

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

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

Returns
Type Description
String

The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

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

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

Returns
Type Description
ByteString

The bytes for creator.

getDefaultInstanceForType()

public Batch getDefaultInstanceForType()
Returns
Type Description
Batch

getEnvironmentConfig()

public EnvironmentConfig getEnvironmentConfig()

Optional. Environment configuration for the batch execution.

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

Returns
Type Description
EnvironmentConfig

The environmentConfig.

getEnvironmentConfigOrBuilder()

public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()

Optional. Environment configuration for the batch execution.

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

Returns
Type Description
EnvironmentConfigOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels to associate with this batch. 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 batch.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public 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. 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 batch.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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. 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 batch.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public 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. 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 batch.

map<string, string> labels = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Output only. The resource name of the batch.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the batch.

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

Returns
Type Description
ByteString

The bytes for name.

getOperation()

public String getOperation()

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

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

Returns
Type Description
String

The operation.

getOperationBytes()

public ByteString getOperationBytes()

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

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

Returns
Type Description
ByteString

The bytes for operation.

getParserForType()

public Parser<Batch> getParserForType()
Returns
Type Description
Parser<Batch>
Overrides

getPysparkBatch()

public PySparkBatch getPysparkBatch()

Optional. PySpark batch config.

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

Returns
Type Description
PySparkBatch

The pysparkBatch.

getPysparkBatchOrBuilder()

public PySparkBatchOrBuilder getPysparkBatchOrBuilder()

Optional. PySpark batch config.

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

Returns
Type Description
PySparkBatchOrBuilder

getRuntimeConfig()

public RuntimeConfig getRuntimeConfig()

Optional. Runtime configuration for the batch execution.

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

Returns
Type Description
RuntimeConfig

The runtimeConfig.

getRuntimeConfigOrBuilder()

public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()

Optional. Runtime configuration for the batch execution.

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

Returns
Type Description
RuntimeConfigOrBuilder

getRuntimeInfo()

public RuntimeInfo getRuntimeInfo()

Output only. Runtime information about batch execution.

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

Returns
Type Description
RuntimeInfo

The runtimeInfo.

getRuntimeInfoOrBuilder()

public RuntimeInfoOrBuilder getRuntimeInfoOrBuilder()

Output only. Runtime information about batch execution.

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

Returns
Type Description
RuntimeInfoOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSparkBatch()

public SparkBatch getSparkBatch()

Optional. Spark batch config.

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

Returns
Type Description
SparkBatch

The sparkBatch.

getSparkBatchOrBuilder()

public SparkBatchOrBuilder getSparkBatchOrBuilder()

Optional. Spark batch config.

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

Returns
Type Description
SparkBatchOrBuilder

getSparkRBatch()

public SparkRBatch getSparkRBatch()

Optional. SparkR batch config.

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

Returns
Type Description
SparkRBatch

The sparkRBatch.

getSparkRBatchOrBuilder()

public SparkRBatchOrBuilder getSparkRBatchOrBuilder()

Optional. SparkR batch config.

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

Returns
Type Description
SparkRBatchOrBuilder

getSparkSqlBatch()

public SparkSqlBatch getSparkSqlBatch()

Optional. SparkSql batch config.

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

Returns
Type Description
SparkSqlBatch

The sparkSqlBatch.

getSparkSqlBatchOrBuilder()

public SparkSqlBatchOrBuilder getSparkSqlBatchOrBuilder()

Optional. SparkSql batch config.

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

Returns
Type Description
SparkSqlBatchOrBuilder

getState()

public 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
Type Description
Batch.State

The state.

getStateHistory(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Batch.StateHistory

getStateHistoryCount()

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

Returns
Type Description
int

getStateHistoryList()

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

Returns
Type Description
List<StateHistory>

getStateHistoryOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
Batch.StateHistoryOrBuilder

getStateHistoryOrBuilderList()

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

Returns
Type Description
List<? extends com.google.cloud.dataproc.v1.Batch.StateHistoryOrBuilder>

getStateMessage()

public 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
Type Description
String

The stateMessage.

getStateMessageBytes()

public 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
Type Description
ByteString

The bytes for stateMessage.

getStateTime()

public 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
Type Description
Timestamp

The stateTime.

getStateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getStateValue()

public int getStateValue()

Output only. The state of the batch.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getUuid()

public 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
Type Description
String

The uuid.

getUuidBytes()

public 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
Type Description
ByteString

The bytes for uuid.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the batch was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasEnvironmentConfig()

public boolean hasEnvironmentConfig()

Optional. Environment configuration for the batch execution.

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

Returns
Type Description
boolean

Whether the environmentConfig field is set.

hasPysparkBatch()

public boolean hasPysparkBatch()

Optional. PySpark batch config.

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

Returns
Type Description
boolean

Whether the pysparkBatch field is set.

hasRuntimeConfig()

public boolean hasRuntimeConfig()

Optional. Runtime configuration for the batch execution.

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

Returns
Type Description
boolean

Whether the runtimeConfig field is set.

hasRuntimeInfo()

public boolean hasRuntimeInfo()

Output only. Runtime information about batch execution.

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

Returns
Type Description
boolean

Whether the runtimeInfo field is set.

hasSparkBatch()

public boolean hasSparkBatch()

Optional. Spark batch config.

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

Returns
Type Description
boolean

Whether the sparkBatch field is set.

hasSparkRBatch()

public boolean hasSparkRBatch()

Optional. SparkR batch config.

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

Returns
Type Description
boolean

Whether the sparkRBatch field is set.

hasSparkSqlBatch()

public boolean hasSparkSqlBatch()

Optional. SparkSql batch config.

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

Returns
Type Description
boolean

Whether the sparkSqlBatch field is set.

hasStateTime()

public 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
Type Description
boolean

Whether the stateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Batch.Builder newBuilderForType()
Returns
Type Description
Batch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Batch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Batch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Batch.Builder toBuilder()
Returns
Type Description
Batch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException