Class WorkItemStatus

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

Inheritance
object
WorkItemStatus
Implements
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3.Data
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class WorkItemStatus : IDirectResponseSchema

Properties

Completed

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

Declaration
[JsonProperty("completed")]
public virtual bool? Completed { get; set; }
Property Value
Type Description
bool?

CounterUpdates

Worker output counters for this WorkItem.

Declaration
[JsonProperty("counterUpdates")]
public virtual IList<CounterUpdate> CounterUpdates { get; set; }
Property Value
Type Description
IList<CounterUpdate>

DynamicSourceSplit

See documentation of stop_position.

Declaration
[JsonProperty("dynamicSourceSplit")]
public virtual DynamicSourceSplit DynamicSourceSplit { get; set; }
Property Value
Type Description
DynamicSourceSplit

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Errors

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

Declaration
[JsonProperty("errors")]
public virtual IList<Status> Errors { get; set; }
Property Value
Type Description
IList<Status>

MetricUpdates

DEPRECATED in favor of counter_updates.

Declaration
[JsonProperty("metricUpdates")]
public virtual IList<MetricUpdate> MetricUpdates { get; set; }
Property Value
Type Description
IList<MetricUpdate>

Progress

DEPRECATED in favor of reported_progress.

Declaration
[JsonProperty("progress")]
public virtual ApproximateProgress Progress { get; set; }
Property Value
Type Description
ApproximateProgress

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.

Declaration
[JsonProperty("reportIndex")]
public virtual long? ReportIndex { get; set; }
Property Value
Type Description
long?

ReportedProgress

The worker's progress through this WorkItem.

Declaration
[JsonProperty("reportedProgress")]
public virtual ApproximateReportedProgress ReportedProgress { get; set; }
Property Value
Type Description
ApproximateReportedProgress

RequestedLeaseDuration

Amount of time the worker requests for its lease.

Declaration
[JsonProperty("requestedLeaseDuration")]
public virtual object RequestedLeaseDuration { get; set; }
Property Value
Type Description
object

SourceFork

DEPRECATED in favor of dynamic_source_split.

Declaration
[JsonProperty("sourceFork")]
public virtual SourceFork SourceFork { get; set; }
Property Value
Type Description
SourceFork

SourceOperationResponse

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

Declaration
[JsonProperty("sourceOperationResponse")]
public virtual SourceOperationResponse SourceOperationResponse { get; set; }
Property Value
Type Description
SourceOperationResponse

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.

Declaration
[JsonProperty("stopPosition")]
public virtual Position StopPosition { get; set; }
Property Value
Type Description
Position

TotalThrottlerWaitTimeSeconds

Total time the worker spent being throttled by external systems.

Declaration
[JsonProperty("totalThrottlerWaitTimeSeconds")]
public virtual double? TotalThrottlerWaitTimeSeconds { get; set; }
Property Value
Type Description
double?

WorkItemId

Identifies the WorkItem.

Declaration
[JsonProperty("workItemId")]
public virtual string WorkItemId { get; set; }
Property Value
Type Description
string

Implements