com.google.api.services.dataflow.model

Class WorkItemStatus

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class WorkItemStatus
extends com.google.api.client.json.GenericJson

Conveys a worker's progress through the work described by a WorkItem.

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 Google Dataflow API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/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
WorkItemStatus()

Method Summary

Methods

Modifier and Type	Method and Description
WorkItemStatus	clone()
java.lang.Boolean	getCompleted() True if the WorkItem was completed (successfully or unsuccessfully).
DynamicSourceSplit	getDynamicSourceSplit() See documentation of stop_position.
java.util.List<Status>	getErrors() Specifies errors which occurred during processing.
java.util.List<MetricUpdate>	getMetricUpdates() Worker output metrics (counters) for this WorkItem.
ApproximateProgress	getProgress() DEPRECATED in favor of reported_progress.
ApproximateReportedProgress	getReportedProgress() The worker's progress through this WorkItem.
java.lang.Long	getReportIndex() The report index.
java.lang.String	getRequestedLeaseDuration() Amount of time the worker requests for its lease.
SourceFork	getSourceFork() DEPRECATED in favor of dynamic_source_split.
SourceOperationResponse	getSourceOperationResponse() If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.
Position	getStopPosition() A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work.
java.lang.String	getWorkItemId() Identifies the WorkItem.
WorkItemStatus	set(java.lang.String fieldName, java.lang.Object value)
WorkItemStatus	setCompleted(java.lang.Boolean completed) True if the WorkItem was completed (successfully or unsuccessfully).
WorkItemStatus	setDynamicSourceSplit(DynamicSourceSplit dynamicSourceSplit) See documentation of stop_position.
WorkItemStatus	setErrors(java.util.List<Status> errors) Specifies errors which occurred during processing.
WorkItemStatus	setMetricUpdates(java.util.List<MetricUpdate> metricUpdates) Worker output metrics (counters) for this WorkItem.
WorkItemStatus	setProgress(ApproximateProgress progress) DEPRECATED in favor of reported_progress.
WorkItemStatus	setReportedProgress(ApproximateReportedProgress reportedProgress) The worker's progress through this WorkItem.
WorkItemStatus	setReportIndex(java.lang.Long reportIndex) The report index.
WorkItemStatus	setRequestedLeaseDuration(java.lang.String requestedLeaseDuration) Amount of time the worker requests for its lease.
WorkItemStatus	setSourceFork(SourceFork sourceFork) DEPRECATED in favor of dynamic_source_split.
WorkItemStatus	setSourceOperationResponse(SourceOperationResponse sourceOperationResponse) If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.
WorkItemStatus	setStopPosition(Position stopPosition) A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work.
WorkItemStatus	setWorkItemId(java.lang.String workItemId) Identifies the WorkItem.

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

Constructor Detail

WorkItemStatus

public WorkItemStatus()

Method Detail

getCompleted

public java.lang.Boolean getCompleted()

True if the WorkItem was completed (successfully or unsuccessfully).

Returns:

value or null for none

setCompleted

public WorkItemStatus setCompleted(java.lang.Boolean completed)

True if the WorkItem was completed (successfully or unsuccessfully).

Parameters:

completed - completed or null for none

getDynamicSourceSplit

public DynamicSourceSplit getDynamicSourceSplit()

See documentation of stop_position.

Returns:

value or null for none

setDynamicSourceSplit

public WorkItemStatus setDynamicSourceSplit(DynamicSourceSplit dynamicSourceSplit)

See documentation of stop_position.

Parameters:

dynamicSourceSplit - dynamicSourceSplit or null for none

getErrors

public java.util.List<Status> getErrors()

Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed.

Returns:

value or null for none

setErrors

public WorkItemStatus setErrors(java.util.List<Status> errors)

Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed.

Parameters:

errors - errors or null for none

getMetricUpdates

public java.util.List<MetricUpdate> getMetricUpdates()

Worker output metrics (counters) for this WorkItem.

Returns:

value or null for none

setMetricUpdates

public WorkItemStatus setMetricUpdates(java.util.List<MetricUpdate> metricUpdates)

Worker output metrics (counters) for this WorkItem.

Parameters:

metricUpdates - metricUpdates or null for none

getProgress

public ApproximateProgress getProgress()

DEPRECATED in favor of reported_progress.

Returns:

value or null for none

setProgress

public WorkItemStatus setProgress(ApproximateProgress progress)

DEPRECATED in favor of reported_progress.

Parameters:

progress - progress or null for none

getReportIndex

public java.lang.Long getReportIndex()

The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service.

Returns:

value or null for none

setReportIndex

public WorkItemStatus setReportIndex(java.lang.Long reportIndex)

The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service.

Parameters:

reportIndex - reportIndex or null for none

getReportedProgress

public ApproximateReportedProgress getReportedProgress()

The worker's progress through this WorkItem.

Returns:

value or null for none

setReportedProgress

public WorkItemStatus setReportedProgress(ApproximateReportedProgress reportedProgress)

The worker's progress through this WorkItem.

Parameters:

reportedProgress - reportedProgress or null for none

getRequestedLeaseDuration

public java.lang.String getRequestedLeaseDuration()

Amount of time the worker requests for its lease.

Returns:

value or null for none

setRequestedLeaseDuration

public WorkItemStatus setRequestedLeaseDuration(java.lang.String requestedLeaseDuration)

Amount of time the worker requests for its lease.

Parameters:

requestedLeaseDuration - requestedLeaseDuration or null for none

getSourceFork

public SourceFork getSourceFork()

DEPRECATED in favor of dynamic_source_split.

Returns:

value or null for none

setSourceFork

public WorkItemStatus setSourceFork(SourceFork sourceFork)

DEPRECATED in favor of dynamic_source_split.

Parameters:

sourceFork - sourceFork or null for none

getSourceOperationResponse

public SourceOperationResponse getSourceOperationResponse()

If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.

Returns:

value or null for none

setSourceOperationResponse

public WorkItemStatus setSourceOperationResponse(SourceOperationResponse sourceOperationResponse)

If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.

Parameters:

sourceOperationResponse - sourceOperationResponse or null for none

getStopPosition

public Position getStopPosition()

A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a "dynamic split" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called "parts" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The "current" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. "75% completed" means "75% of [A, C) completed" * The worker should interpret proposed_stop_position relative to the new range, e.g. "split at 68%" should be interpreted as "split at 68% of [A, C)". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc.

Returns:

value or null for none

setStopPosition

public WorkItemStatus setStopPosition(Position stopPosition)

A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a "dynamic split" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called "parts" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The "current" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. "75% completed" means "75% of [A, C) completed" * The worker should interpret proposed_stop_position relative to the new range, e.g. "split at 68%" should be interpreted as "split at 68% of [A, C)". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc.

Parameters:

stopPosition - stopPosition or null for none

getWorkItemId

public java.lang.String getWorkItemId()

Identifies the WorkItem.

Returns:

value or null for none

setWorkItemId

public WorkItemStatus setWorkItemId(java.lang.String workItemId)

Identifies the WorkItem.

Parameters:

workItemId - workItemId or null for none

set

public WorkItemStatus set(java.lang.String fieldName,
                 java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public WorkItemStatus clone()

Overrides:

clone in class com.google.api.client.json.GenericJson