WorkItemServiceState

import type { WorkItemServiceState } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

The Dataflow service's idea of the current state of a WorkItem being processed by a worker.

interface WorkItemServiceState {

completeWorkStatus?: Status;

harnessData?: {

[key: string]: any;

};

hotKeyDetection?: HotKeyDetection;

leaseExpireTime?: Date;

metricShortId?: MetricShortId[];

nextReportIndex?: bigint;

reportStatusInterval?: number;

splitRequest?: ApproximateSplitRequest;

suggestedStopPoint?: ApproximateProgress;

suggestedStopPosition?: Position;

}

§Properties

completeWorkStatus?: Status

[src]

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.

harnessData?: {

[key: string]: any;

}

[src]

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

hotKeyDetection?: HotKeyDetection

[src]

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.

leaseExpireTime?: Date

[src]

Time at which the current lease will expire.

metricShortId?: MetricShortId[]

[src]

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.

nextReportIndex?: bigint

[src]

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.

reportStatusInterval?: number

[src]

New recommended reporting interval.

splitRequest?: ApproximateSplitRequest

[src]

The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.

suggestedStopPoint?: ApproximateProgress

[src]

DEPRECATED in favor of split_request.

suggestedStopPosition?: Position

[src]

Obsolete, always empty.