WorkItem (Dataflow API v1b3-rev20240603-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.dataflow.model.WorkItem

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class WorkItem
extends com.google.api.client.json.GenericJson
```
WorkItem represents basic information about a WorkItem to be executed in the cloud.
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 Dataflow 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

WorkItem()

Constructors
Constructor and Description
`WorkItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkItem`	`clone()`
`String`	`getConfiguration()` Work item-specific configuration as an opaque blob.
`Long`	`getId()` Identifies this WorkItem.
`Long`	`getInitialReportIndex()` The initial index to use when reporting the status of the WorkItem.
`String`	`getJobId()` Identifies the workflow job this WorkItem belongs to.
`String`	`getLeaseExpireTime()` Time when the lease on this Work will expire.
`MapTask`	`getMapTask()` Additional information for MapTask WorkItems.
`List<DataflowPackage>`	`getPackages()` Any required packages that need to be fetched in order to execute this WorkItem.
`String`	`getProjectId()` Identifies the cloud project this WorkItem belongs to.
`String`	`getReportStatusInterval()` Recommended reporting interval.
`SeqMapTask`	`getSeqMapTask()` Additional information for SeqMapTask WorkItems.
`ShellTask`	`getShellTask()` Additional information for ShellTask WorkItems.
`SourceOperationRequest`	`getSourceOperationTask()` Additional information for source operation WorkItems.
`StreamingComputationTask`	`getStreamingComputationTask()` Additional information for StreamingComputationTask WorkItems.
`StreamingConfigTask`	`getStreamingConfigTask()` Additional information for StreamingConfigTask WorkItems.
`StreamingSetupTask`	`getStreamingSetupTask()` Additional information for StreamingSetupTask WorkItems.
`WorkItem`	`set(String fieldName, Object value)`
`WorkItem`	`setConfiguration(String configuration)` Work item-specific configuration as an opaque blob.
`WorkItem`	`setId(Long id)` Identifies this WorkItem.
`WorkItem`	`setInitialReportIndex(Long initialReportIndex)` The initial index to use when reporting the status of the WorkItem.
`WorkItem`	`setJobId(String jobId)` Identifies the workflow job this WorkItem belongs to.
`WorkItem`	`setLeaseExpireTime(String leaseExpireTime)` Time when the lease on this Work will expire.
`WorkItem`	`setMapTask(MapTask mapTask)` Additional information for MapTask WorkItems.
`WorkItem`	`setPackages(List<DataflowPackage> packages)` Any required packages that need to be fetched in order to execute this WorkItem.
`WorkItem`	`setProjectId(String projectId)` Identifies the cloud project this WorkItem belongs to.
`WorkItem`	`setReportStatusInterval(String reportStatusInterval)` Recommended reporting interval.
`WorkItem`	`setSeqMapTask(SeqMapTask seqMapTask)` Additional information for SeqMapTask WorkItems.
`WorkItem`	`setShellTask(ShellTask shellTask)` Additional information for ShellTask WorkItems.
`WorkItem`	`setSourceOperationTask(SourceOperationRequest sourceOperationTask)` Additional information for source operation WorkItems.
`WorkItem`	`setStreamingComputationTask(StreamingComputationTask streamingComputationTask)` Additional information for StreamingComputationTask WorkItems.
`WorkItem`	`setStreamingConfigTask(StreamingConfigTask streamingConfigTask)` Additional information for StreamingConfigTask WorkItems.
`WorkItem`	`setStreamingSetupTask(StreamingSetupTask streamingSetupTask)` Additional information for StreamingSetupTask WorkItems.

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
  - WorkItem
```
public WorkItem()
```
- Method Detail
  - getConfiguration
```
public String getConfiguration()
```
    Work item-specific configuration as an opaque blob.
    
    Returns:
    
    value or null for none
  - setConfiguration
```
public WorkItem setConfiguration(String configuration)
```
    Work item-specific configuration as an opaque blob.
    
    Parameters:
    
    configuration - configuration or null for none
  - getId
```
public Long getId()
```
    Identifies this WorkItem.
    
    Returns:
    
    value or null for none
  - setId
```
public WorkItem setId(Long id)
```
    Identifies this WorkItem.
    
    Parameters:
    
    id - id or null for none
  - getInitialReportIndex
```
public Long getInitialReportIndex()
```
    The initial index to use when reporting the status of the WorkItem.
    
    Returns:
    
    value or null for none
  - setInitialReportIndex
```
public WorkItem setInitialReportIndex(Long initialReportIndex)
```
    The initial index to use when reporting the status of the WorkItem.
    
    Parameters:
    
    initialReportIndex - initialReportIndex or null for none
  - getJobId
```
public String getJobId()
```
    Identifies the workflow job this WorkItem belongs to.
    
    Returns:
    
    value or null for none
  - setJobId
```
public WorkItem setJobId(String jobId)
```
    Identifies the workflow job this WorkItem belongs to.
    
    Parameters:
    
    jobId - jobId or null for none
  - getLeaseExpireTime
```
public String getLeaseExpireTime()
```
    Time when the lease on this Work will expire.
    
    Returns:
    
    value or null for none
  - setLeaseExpireTime
```
public WorkItem setLeaseExpireTime(String leaseExpireTime)
```
    Time when the lease on this Work will expire.
    
    Parameters:
    
    leaseExpireTime - leaseExpireTime or null for none
  - getMapTask
```
public MapTask getMapTask()
```
    Additional information for MapTask WorkItems.
    
    Returns:
    
    value or null for none
  - setMapTask
```
public WorkItem setMapTask(MapTask mapTask)
```
    Additional information for MapTask WorkItems.
    
    Parameters:
    
    mapTask - mapTask or null for none
  - getPackages
```
public List<DataflowPackage> getPackages()
```
    Any required packages that need to be fetched in order to execute this WorkItem.
    
    Returns:
    
    value or null for none
  - setPackages
```
public WorkItem setPackages(List<DataflowPackage> packages)
```
    Any required packages that need to be fetched in order to execute this WorkItem.
    
    Parameters:
    
    packages - packages or null for none
  - getProjectId
```
public String getProjectId()
```
    Identifies the cloud project this WorkItem belongs to.
    
    Returns:
    
    value or null for none
  - setProjectId
```
public WorkItem setProjectId(String projectId)
```
    Identifies the cloud project this WorkItem belongs to.
    
    Parameters:
    
    projectId - projectId or null for none
  - getReportStatusInterval
```
public String getReportStatusInterval()
```
    Recommended reporting interval.
    
    Returns:
    
    value or null for none
  - setReportStatusInterval
```
public WorkItem setReportStatusInterval(String reportStatusInterval)
```
    Recommended reporting interval.
    
    Parameters:
    
    reportStatusInterval - reportStatusInterval or null for none
  - getSeqMapTask
```
public SeqMapTask getSeqMapTask()
```
    Additional information for SeqMapTask WorkItems.
    
    Returns:
    
    value or null for none
  - setSeqMapTask
```
public WorkItem setSeqMapTask(SeqMapTask seqMapTask)
```
    Additional information for SeqMapTask WorkItems.
    
    Parameters:
    
    seqMapTask - seqMapTask or null for none
  - getShellTask
```
public ShellTask getShellTask()
```
    Additional information for ShellTask WorkItems.
    
    Returns:
    
    value or null for none
  - setShellTask
```
public WorkItem setShellTask(ShellTask shellTask)
```
    Additional information for ShellTask WorkItems.
    
    Parameters:
    
    shellTask - shellTask or null for none
  - getSourceOperationTask
```
public SourceOperationRequest getSourceOperationTask()
```
    Additional information for source operation WorkItems.
    
    Returns:
    
    value or null for none
  - setSourceOperationTask
```
public WorkItem setSourceOperationTask(SourceOperationRequest sourceOperationTask)
```
    Additional information for source operation WorkItems.
    
    Parameters:
    
    sourceOperationTask - sourceOperationTask or null for none
  - getStreamingComputationTask
```
public StreamingComputationTask getStreamingComputationTask()
```
    Additional information for StreamingComputationTask WorkItems.
    
    Returns:
    
    value or null for none
  - setStreamingComputationTask
```
public WorkItem setStreamingComputationTask(StreamingComputationTask streamingComputationTask)
```
    Additional information for StreamingComputationTask WorkItems.
    
    Parameters:
    
    streamingComputationTask - streamingComputationTask or null for none
  - getStreamingConfigTask
```
public StreamingConfigTask getStreamingConfigTask()
```
    Additional information for StreamingConfigTask WorkItems.
    
    Returns:
    
    value or null for none
  - setStreamingConfigTask
```
public WorkItem setStreamingConfigTask(StreamingConfigTask streamingConfigTask)
```
    Additional information for StreamingConfigTask WorkItems.
    
    Parameters:
    
    streamingConfigTask - streamingConfigTask or null for none
  - getStreamingSetupTask
```
public StreamingSetupTask getStreamingSetupTask()
```
    Additional information for StreamingSetupTask WorkItems.
    
    Returns:
    
    value or null for none
  - setStreamingSetupTask
```
public WorkItem setStreamingSetupTask(StreamingSetupTask streamingSetupTask)
```
    Additional information for StreamingSetupTask WorkItems.
    
    Parameters:
    
    streamingSetupTask - streamingSetupTask or null for none
  - set
```
public WorkItem set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkItem clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class WorkItem

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

WorkItem

Method Detail

getConfiguration

setConfiguration

getId

setId

getInitialReportIndex

setInitialReportIndex

getJobId

setJobId

getLeaseExpireTime

setLeaseExpireTime

getMapTask

setMapTask

getPackages

setPackages

getProjectId

setProjectId

getReportStatusInterval

setReportStatusInterval

getSeqMapTask

setSeqMapTask

getShellTask

setShellTask

getSourceOperationTask

setSourceOperationTask

getStreamingComputationTask

setStreamingComputationTask

getStreamingConfigTask

setStreamingConfigTask

getStreamingSetupTask

setStreamingSetupTask

set

clone