Batch (Cloud Dataproc API v1-rev20231002-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.dataproc.model.Batch

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Batch
extends com.google.api.client.json.GenericJson
```
A representation of a batch workload in the service.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Batch()

Constructors
Constructor and Description
`Batch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Batch`	`clone()`
`String`	`getCreateTime()` Output only.
`String`	`getCreator()` Output only.
`EnvironmentConfig`	`getEnvironmentConfig()` Optional.
`Map<String,String>`	`getLabels()` Optional.
`String`	`getName()` Output only.
`String`	`getOperation()` Output only.
`PySparkBatch`	`getPysparkBatch()` Optional.
`RuntimeConfig`	`getRuntimeConfig()` Optional.
`RuntimeInfo`	`getRuntimeInfo()` Output only.
`SparkBatch`	`getSparkBatch()` Optional.
`SparkRBatch`	`getSparkRBatch()` Optional.
`SparkSqlBatch`	`getSparkSqlBatch()` Optional.
`String`	`getState()` Output only.
`List<StateHistory>`	`getStateHistory()` Output only.
`String`	`getStateMessage()` Output only.
`String`	`getStateTime()` Output only.
`String`	`getUuid()` Output only.
`Batch`	`set(String fieldName, Object value)`
`Batch`	`setCreateTime(String createTime)` Output only.
`Batch`	`setCreator(String creator)` Output only.
`Batch`	`setEnvironmentConfig(EnvironmentConfig environmentConfig)` Optional.
`Batch`	`setLabels(Map<String,String> labels)` Optional.
`Batch`	`setName(String name)` Output only.
`Batch`	`setOperation(String operation)` Output only.
`Batch`	`setPysparkBatch(PySparkBatch pysparkBatch)` Optional.
`Batch`	`setRuntimeConfig(RuntimeConfig runtimeConfig)` Optional.
`Batch`	`setRuntimeInfo(RuntimeInfo runtimeInfo)` Output only.
`Batch`	`setSparkBatch(SparkBatch sparkBatch)` Optional.
`Batch`	`setSparkRBatch(SparkRBatch sparkRBatch)` Optional.
`Batch`	`setSparkSqlBatch(SparkSqlBatch sparkSqlBatch)` Optional.
`Batch`	`setState(String state)` Output only.
`Batch`	`setStateHistory(List<StateHistory> stateHistory)` Output only.
`Batch`	`setStateMessage(String stateMessage)` Output only.
`Batch`	`setStateTime(String stateTime)` Output only.
`Batch`	`setUuid(String uuid)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Batch
```
public Batch()
```
- Method Detail
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time when the batch was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Batch setCreateTime(String createTime)
```
    Output only. The time when the batch was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCreator
```
public String getCreator()
```
    Output only. The email address of the user who created the batch.
    
    Returns:
    
    value or null for none
  - setCreator
```
public Batch setCreator(String creator)
```
    Output only. The email address of the user who created the batch.
    
    Parameters:
    
    creator - creator or null for none
  - getEnvironmentConfig
```
public EnvironmentConfig getEnvironmentConfig()
```
    Optional. Environment configuration for the batch execution.
    
    Returns:
    
    value or null for none
  - setEnvironmentConfig
```
public Batch setEnvironmentConfig(EnvironmentConfig environmentConfig)
```
    Optional. Environment configuration for the batch execution.
    
    Parameters:
    
    environmentConfig - environmentConfig or null for none
  - getLabels
```
public Map<String,String> 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.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Batch setLabels(Map<String,String> labels)
```
    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.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the batch.
    
    Returns:
    
    value or null for none
  - setName
```
public Batch setName(String name)
```
    Output only. The resource name of the batch.
    
    Parameters:
    
    name - name or null for none
  - getOperation
```
public String getOperation()
```
    Output only. The resource name of the operation associated with this batch.
    
    Returns:
    
    value or null for none
  - setOperation
```
public Batch setOperation(String operation)
```
    Output only. The resource name of the operation associated with this batch.
    
    Parameters:
    
    operation - operation or null for none
  - getPysparkBatch
```
public PySparkBatch getPysparkBatch()
```
    Optional. PySpark batch config.
    
    Returns:
    
    value or null for none
  - setPysparkBatch
```
public Batch setPysparkBatch(PySparkBatch pysparkBatch)
```
    Optional. PySpark batch config.
    
    Parameters:
    
    pysparkBatch - pysparkBatch or null for none
  - getRuntimeConfig
```
public RuntimeConfig getRuntimeConfig()
```
    Optional. Runtime configuration for the batch execution.
    
    Returns:
    
    value or null for none
  - setRuntimeConfig
```
public Batch setRuntimeConfig(RuntimeConfig runtimeConfig)
```
    Optional. Runtime configuration for the batch execution.
    
    Parameters:
    
    runtimeConfig - runtimeConfig or null for none
  - getRuntimeInfo
```
public RuntimeInfo getRuntimeInfo()
```
    Output only. Runtime information about batch execution.
    
    Returns:
    
    value or null for none
  - setRuntimeInfo
```
public Batch setRuntimeInfo(RuntimeInfo runtimeInfo)
```
    Output only. Runtime information about batch execution.
    
    Parameters:
    
    runtimeInfo - runtimeInfo or null for none
  - getSparkBatch
```
public SparkBatch getSparkBatch()
```
    Optional. Spark batch config.
    
    Returns:
    
    value or null for none
  - setSparkBatch
```
public Batch setSparkBatch(SparkBatch sparkBatch)
```
    Optional. Spark batch config.
    
    Parameters:
    
    sparkBatch - sparkBatch or null for none
  - getSparkRBatch
```
public SparkRBatch getSparkRBatch()
```
    Optional. SparkR batch config.
    
    Returns:
    
    value or null for none
  - setSparkRBatch
```
public Batch setSparkRBatch(SparkRBatch sparkRBatch)
```
    Optional. SparkR batch config.
    
    Parameters:
    
    sparkRBatch - sparkRBatch or null for none
  - getSparkSqlBatch
```
public SparkSqlBatch getSparkSqlBatch()
```
    Optional. SparkSql batch config.
    
    Returns:
    
    value or null for none
  - setSparkSqlBatch
```
public Batch setSparkSqlBatch(SparkSqlBatch sparkSqlBatch)
```
    Optional. SparkSql batch config.
    
    Parameters:
    
    sparkSqlBatch - sparkSqlBatch or null for none
  - getState
```
public String getState()
```
    Output only. The state of the batch.
    
    Returns:
    
    value or null for none
  - setState
```
public Batch setState(String state)
```
    Output only. The state of the batch.
    
    Parameters:
    
    state - state or null for none
  - getStateHistory
```
public List<StateHistory> getStateHistory()
```
    Output only. Historical state information for the batch.
    
    Returns:
    
    value or null for none
  - setStateHistory
```
public Batch setStateHistory(List<StateHistory> stateHistory)
```
    Output only. Historical state information for the batch.
    
    Parameters:
    
    stateHistory - stateHistory or null for none
  - getStateMessage
```
public String getStateMessage()
```
    Output only. Batch state details, such as a failure description if the state is FAILED.
    
    Returns:
    
    value or null for none
  - setStateMessage
```
public Batch setStateMessage(String stateMessage)
```
    Output only. Batch state details, such as a failure description if the state is FAILED.
    
    Parameters:
    
    stateMessage - stateMessage or null for none
  - getStateTime
```
public String getStateTime()
```
    Output only. The time when the batch entered a current state.
    
    Returns:
    
    value or null for none
  - setStateTime
```
public Batch setStateTime(String stateTime)
```
    Output only. The time when the batch entered a current state.
    
    Parameters:
    
    stateTime - stateTime or null for none
  - getUuid
```
public String getUuid()
```
    Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.
    
    Returns:
    
    value or null for none
  - setUuid
```
public Batch setUuid(String uuid)
```
    Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.
    
    Parameters:
    
    uuid - uuid or null for none
  - set
```
public Batch set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Batch clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Batch

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Batch

Method Detail

getCreateTime

setCreateTime

getCreator

setCreator

getEnvironmentConfig

setEnvironmentConfig

getLabels

setLabels

getName

setName

getOperation

setOperation

getPysparkBatch

setPysparkBatch

getRuntimeConfig

setRuntimeConfig

getRuntimeInfo

setRuntimeInfo

getSparkBatch

setSparkBatch

getSparkRBatch

setSparkRBatch

getSparkSqlBatch

setSparkSqlBatch

getState

setState

getStateHistory

setStateHistory

getStateMessage

setStateMessage

getStateTime

setStateTime

getUuid

setUuid

set

clone