Interface BatchOrBuilder (4.33.0)

Version 4.33.0

• 4.50.0 (latest)
• 4.49.0
• 4.48.0
• 4.46.0
• 4.45.0
• 4.44.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.34.0
• 4.33.0
• 4.32.0
• 4.31.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.16.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.0
• 4.8.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.8
• 3.1.2
• 3.0.3
• 2.3.1

public interface BatchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getBatchConfigCase()

public abstract Batch.BatchConfigCase getBatchConfigCase()

Returns
Type	Description
Batch.BatchConfigCase

getCreateTime()

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

getEnvironmentConfig()

public abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

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

getPysparkBatch()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getSparkBatch()

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