WorkItemServiceState (Dataflow API v1b3 (Rev. 278) 1.25.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class WorkItemServiceState
extends com.google.api.client.json.GenericJson
```
The Dataflow service's idea of the current state of a WorkItem being processed by a worker.
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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

WorkItemServiceState()

Constructors
Constructor and Description
`WorkItemServiceState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkItemServiceState`	`clone()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getHarnessData()` Other data returned by the service, specific to the particular worker harness.
`java.lang.String`	`getLeaseExpireTime()` Time at which the current lease will expire.
`java.util.List<MetricShortId>`	`getMetricShortId()` The short ids that workers should use in subsequent metric updates.
`java.lang.Long`	`getNextReportIndex()` The index value to use for the next report sent by the worker.
`java.lang.String`	`getReportStatusInterval()` New recommended reporting interval.
`ApproximateSplitRequest`	`getSplitRequest()` The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
`ApproximateProgress`	`getSuggestedStopPoint()` DEPRECATED in favor of split_request.
`Position`	`getSuggestedStopPosition()` Obsolete, always empty.
`WorkItemServiceState`	`set(java.lang.String fieldName, java.lang.Object value)`
`WorkItemServiceState`	`setHarnessData(java.util.Map<java.lang.String,java.lang.Object> harnessData)` Other data returned by the service, specific to the particular worker harness.
`WorkItemServiceState`	`setLeaseExpireTime(java.lang.String leaseExpireTime)` Time at which the current lease will expire.
`WorkItemServiceState`	`setMetricShortId(java.util.List<MetricShortId> metricShortId)` The short ids that workers should use in subsequent metric updates.
`WorkItemServiceState`	`setNextReportIndex(java.lang.Long nextReportIndex)` The index value to use for the next report sent by the worker.
`WorkItemServiceState`	`setReportStatusInterval(java.lang.String reportStatusInterval)` New recommended reporting interval.
`WorkItemServiceState`	`setSplitRequest(ApproximateSplitRequest splitRequest)` The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
`WorkItemServiceState`	`setSuggestedStopPoint(ApproximateProgress suggestedStopPoint)` DEPRECATED in favor of split_request.
`WorkItemServiceState`	`setSuggestedStopPosition(Position suggestedStopPosition)` Obsolete, always empty.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - WorkItemServiceState
```
public WorkItemServiceState()
```
- Method Detail
  - getHarnessData
```
public java.util.Map<java.lang.String,java.lang.Object> getHarnessData()
```
    Other data returned by the service, specific to the particular worker harness.
    
    Returns:
    
    value or null for none
  - setHarnessData
```
public WorkItemServiceState setHarnessData(java.util.Map<java.lang.String,java.lang.Object> harnessData)
```
    Other data returned by the service, specific to the particular worker harness.
    
    Parameters:
    
    harnessData - harnessData or null for none
  - getLeaseExpireTime
```
public java.lang.String getLeaseExpireTime()
```
    Time at which the current lease will expire.
    
    Returns:
    
    value or null for none
  - setLeaseExpireTime
```
public WorkItemServiceState setLeaseExpireTime(java.lang.String leaseExpireTime)
```
    Time at which the current lease will expire.
    
    Parameters:
    
    leaseExpireTime - leaseExpireTime or null for none
  - getMetricShortId
```
public java.util.List<MetricShortId> getMetricShortId()
```
    The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics.
    
    Returns:
    
    value or null for none
  - setMetricShortId
```
public WorkItemServiceState setMetricShortId(java.util.List<MetricShortId> metricShortId)
```
    The short ids that workers should use in subsequent metric updates. Workers should strive to use short ids whenever possible, but it is ok to request the short_id again if a worker lost track of it (e.g. if the worker is recovering from a crash). NOTE: it is possible that the response may have short ids for a subset of the metrics.
    
    Parameters:
    
    metricShortId - metricShortId or null for none
  - getNextReportIndex
```
public java.lang.Long getNextReportIndex()
```
    The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.
    
    Returns:
    
    value or null for none
  - setNextReportIndex
```
public WorkItemServiceState setNextReportIndex(java.lang.Long nextReportIndex)
```
    The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.
    
    Parameters:
    
    nextReportIndex - nextReportIndex or null for none
  - getReportStatusInterval
```
public java.lang.String getReportStatusInterval()
```
    New recommended reporting interval.
    
    Returns:
    
    value or null for none
  - setReportStatusInterval
```
public WorkItemServiceState setReportStatusInterval(java.lang.String reportStatusInterval)
```
    New recommended reporting interval.
    
    Parameters:
    
    reportStatusInterval - reportStatusInterval or null for none
  - getSplitRequest
```
public ApproximateSplitRequest getSplitRequest()
```
    The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
    
    Returns:
    
    value or null for none
  - setSplitRequest
```
public WorkItemServiceState setSplitRequest(ApproximateSplitRequest splitRequest)
```
    The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
    
    Parameters:
    
    splitRequest - splitRequest or null for none
  - getSuggestedStopPoint
```
public ApproximateProgress getSuggestedStopPoint()
```
    DEPRECATED in favor of split_request.
    
    Returns:
    
    value or null for none
  - setSuggestedStopPoint
```
public WorkItemServiceState setSuggestedStopPoint(ApproximateProgress suggestedStopPoint)
```
    DEPRECATED in favor of split_request.
    
    Parameters:
    
    suggestedStopPoint - suggestedStopPoint or null for none
  - getSuggestedStopPosition
```
public Position getSuggestedStopPosition()
```
    Obsolete, always empty.
    
    Returns:
    
    value or null for none
  - setSuggestedStopPosition
```
public WorkItemServiceState setSuggestedStopPosition(Position suggestedStopPosition)
```
    Obsolete, always empty.
    
    Parameters:
    
    suggestedStopPosition - suggestedStopPosition or null for none
  - set
```
public WorkItemServiceState set(java.lang.String fieldName,
                                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkItemServiceState clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Dataflow API v1b3 (revision 278)

Class WorkItemServiceState

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

WorkItemServiceState

Method Detail

getHarnessData

setHarnessData

getLeaseExpireTime

setLeaseExpireTime

getMetricShortId

setMetricShortId

getNextReportIndex

setNextReportIndex

getReportStatusInterval

setReportStatusInterval

getSplitRequest

setSplitRequest

getSuggestedStopPoint

setSuggestedStopPoint

getSuggestedStopPosition

setSuggestedStopPosition

set

clone