com.google.api.services.dataflow.model

Class WorkItemServiceState

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.WorkItemServiceState

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class WorkItemServiceState
extends 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

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
WorkItemServiceState()

Method Summary

Modifier and Type	Method and Description
WorkItemServiceState	clone()
Status	getCompleteWorkStatus() If set, a request to complete the work item with the given status.
Map<String,Object>	getHarnessData() Other data returned by the service, specific to the particular worker harness.
HotKeyDetection	getHotKeyDetection() A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance.
String	getLeaseExpireTime() Time at which the current lease will expire.
List<MetricShortId>	getMetricShortId() The short ids that workers should use in subsequent metric updates.
Long	getNextReportIndex() The index value to use for the next report sent by the worker.
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(String fieldName, Object value)
WorkItemServiceState	setCompleteWorkStatus(Status completeWorkStatus) If set, a request to complete the work item with the given status.
WorkItemServiceState	setHarnessData(Map<String,Object> harnessData) Other data returned by the service, specific to the particular worker harness.
WorkItemServiceState	setHotKeyDetection(HotKeyDetection hotKeyDetection) A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance.
WorkItemServiceState	setLeaseExpireTime(String leaseExpireTime) Time at which the current lease will expire.
WorkItemServiceState	setMetricShortId(List<MetricShortId> metricShortId) The short ids that workers should use in subsequent metric updates.
WorkItemServiceState	setNextReportIndex(Long nextReportIndex) The index value to use for the next report sent by the worker.
WorkItemServiceState	setReportStatusInterval(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, 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

WorkItemServiceState

public WorkItemServiceState()

Method Detail

getCompleteWorkStatus

public Status getCompleteWorkStatus()

If set, a request to complete the work item with the given status. This will not be set to OK, unless supported by the specific kind of WorkItem. It can be used for the backend to indicate a WorkItem must terminate, e.g., for aborting work.

Returns:

value or null for none

setCompleteWorkStatus

public WorkItemServiceState setCompleteWorkStatus(Status completeWorkStatus)

If set, a request to complete the work item with the given status. This will not be set to OK, unless supported by the specific kind of WorkItem. It can be used for the backend to indicate a WorkItem must terminate, e.g., for aborting work.

Parameters:

completeWorkStatus - completeWorkStatus or null for none

getHarnessData

public Map<String,Object> getHarnessData()

Other data returned by the service, specific to the particular worker harness.

Returns:

value or null for none

setHarnessData

public WorkItemServiceState setHarnessData(Map<String,Object> harnessData)

Other data returned by the service, specific to the particular worker harness.

Parameters:

harnessData - harnessData or null for none

getHotKeyDetection

public HotKeyDetection getHotKeyDetection()

A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance. When present, this field includes metadata associated with any hot key.

Returns:

value or null for none

setHotKeyDetection

public WorkItemServiceState setHotKeyDetection(HotKeyDetection hotKeyDetection)

A hot key is a symptom of poor data distribution in which there are enough elements mapped to a single key to impact pipeline performance. When present, this field includes metadata associated with any hot key.

Parameters:

hotKeyDetection - hotKeyDetection or null for none

getLeaseExpireTime

public String getLeaseExpireTime()

Time at which the current lease will expire.

Returns:

value or null for none

setLeaseExpireTime

public WorkItemServiceState setLeaseExpireTime(String leaseExpireTime)

Time at which the current lease will expire.

Parameters:

leaseExpireTime - leaseExpireTime or null for none

getMetricShortId

public 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(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 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(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 String getReportStatusInterval()

New recommended reporting interval.

Returns:

value or null for none

setReportStatusInterval

public WorkItemServiceState setReportStatusInterval(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(String fieldName,
                                Object value)

Overrides:

set in class GenericJson

clone

public WorkItemServiceState clone()

Overrides:

clone in class GenericJson