public final class Batch extends GeneratedMessageV3 implements BatchOrBuilder
A representation of a batch workload in the service.
Protobuf type google.cloud.dataproc.v1.Batch
Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
CREATOR_FIELD_NUMBER
public static final int CREATOR_FIELD_NUMBER
Field Value
ENVIRONMENT_CONFIG_FIELD_NUMBER
public static final int ENVIRONMENT_CONFIG_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
OPERATION_FIELD_NUMBER
public static final int OPERATION_FIELD_NUMBER
Field Value
PYSPARK_BATCH_FIELD_NUMBER
public static final int PYSPARK_BATCH_FIELD_NUMBER
Field Value
RUNTIME_CONFIG_FIELD_NUMBER
public static final int RUNTIME_CONFIG_FIELD_NUMBER
Field Value
RUNTIME_INFO_FIELD_NUMBER
public static final int RUNTIME_INFO_FIELD_NUMBER
Field Value
SPARK_BATCH_FIELD_NUMBER
public static final int SPARK_BATCH_FIELD_NUMBER
Field Value
SPARK_R_BATCH_FIELD_NUMBER
public static final int SPARK_R_BATCH_FIELD_NUMBER
Field Value
SPARK_SQL_BATCH_FIELD_NUMBER
public static final int SPARK_SQL_BATCH_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
STATE_HISTORY_FIELD_NUMBER
public static final int STATE_HISTORY_FIELD_NUMBER
Field Value
STATE_MESSAGE_FIELD_NUMBER
public static final int STATE_MESSAGE_FIELD_NUMBER
Field Value
STATE_TIME_FIELD_NUMBER
public static final int STATE_TIME_FIELD_NUMBER
Field Value
UUID_FIELD_NUMBER
public static final int UUID_FIELD_NUMBER
Field Value
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBatchConfigCase()
public Batch.BatchConfigCase getBatchConfigCase()
Returns
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];
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];
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];
| 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];
getDefaultInstance()
public static Batch getDefaultInstance()
Returns
getDefaultInstanceForType()
public Batch getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getEnvironmentConfig()
public EnvironmentConfig getEnvironmentConfig()
Optional. Environment configuration for the batch execution.
.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
getEnvironmentConfigOrBuilder()
public EnvironmentConfigOrBuilder getEnvironmentConfigOrBuilder()
Optional. Environment configuration for the batch execution.
.google.cloud.dataproc.v1.EnvironmentConfig environment_config = 15 [(.google.api.field_behavior) = OPTIONAL];
getLabels()
public Map<String,String> getLabels()
Returns
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];
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];
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];
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];
getName()
Output only. The resource name of the batch.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
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];
| 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];
getParserForType()
public Parser<Batch> getParserForType()
Returns
Overrides
getPysparkBatch()
public PySparkBatch getPysparkBatch()
Optional. PySpark batch config.
.google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
getPysparkBatchOrBuilder()
public PySparkBatchOrBuilder getPysparkBatchOrBuilder()
Optional. PySpark batch config.
.google.cloud.dataproc.v1.PySparkBatch pyspark_batch = 4 [(.google.api.field_behavior) = OPTIONAL];
getRuntimeConfig()
public RuntimeConfig getRuntimeConfig()
Optional. Runtime configuration for the batch execution.
.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
getRuntimeConfigOrBuilder()
public RuntimeConfigOrBuilder getRuntimeConfigOrBuilder()
Optional. Runtime configuration for the batch execution.
.google.cloud.dataproc.v1.RuntimeConfig runtime_config = 14 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSparkBatch()
public SparkBatch getSparkBatch()
Optional. Spark batch config.
.google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
getSparkBatchOrBuilder()
public SparkBatchOrBuilder getSparkBatchOrBuilder()
Optional. Spark batch config.
.google.cloud.dataproc.v1.SparkBatch spark_batch = 5 [(.google.api.field_behavior) = OPTIONAL];
getSparkRBatch()
public SparkRBatch getSparkRBatch()
Optional. SparkR batch config.
.google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
getSparkRBatchOrBuilder()
public SparkRBatchOrBuilder getSparkRBatchOrBuilder()
Optional. SparkR batch config.
.google.cloud.dataproc.v1.SparkRBatch spark_r_batch = 6 [(.google.api.field_behavior) = OPTIONAL];
getSparkSqlBatch()
public SparkSqlBatch getSparkSqlBatch()
Optional. SparkSql batch config.
.google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
getSparkSqlBatchOrBuilder()
public SparkSqlBatchOrBuilder getSparkSqlBatchOrBuilder()
Optional. SparkSql batch config.
.google.cloud.dataproc.v1.SparkSqlBatch spark_sql_batch = 7 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
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];
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];
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];
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];
| 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];
| 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];
| 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];
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| 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];
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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the stateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Batch.Builder newBuilder()
Returns
newBuilder(Batch prototype)
public static Batch.Builder newBuilder(Batch prototype)
Parameter
| Name | Description |
| prototype | Batch
|
Returns
newBuilderForType()
public Batch.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Batch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Batch parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Batch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Batch parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Batch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Batch parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Batch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Batch parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Batch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Batch parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Batch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Batch parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Batch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Batch> parser()
Returns
toBuilder()
public Batch.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
