Class WorkItemServiceState

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

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

Properties

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.

Declaration
[JsonProperty("completeWorkStatus")]
public virtual Status CompleteWorkStatus { get; set; }
Property Value
Type Description
Status

ETag

The ETag of the item.

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

HarnessData

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

Declaration
[JsonProperty("harnessData")]
public virtual IDictionary<string, object> HarnessData { get; set; }
Property Value
Type Description
IDictionary<string, object>

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.

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

LeaseExpireTime

object representation of LeaseExpireTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LeaseExpireTimeDateTimeOffset instead.")]
public virtual object LeaseExpireTime { get; set; }
Property Value
Type Description
object

LeaseExpireTimeDateTimeOffset

DateTimeOffset representation of LeaseExpireTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LeaseExpireTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LeaseExpireTimeRaw

Time at which the current lease will expire.

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

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.

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

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.

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

ReportStatusInterval

New recommended reporting interval.

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

SplitRequest

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

Declaration
[JsonProperty("splitRequest")]
public virtual ApproximateSplitRequest SplitRequest { get; set; }
Property Value
Type Description
ApproximateSplitRequest

SuggestedStopPoint

DEPRECATED in favor of split_request.

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

SuggestedStopPosition

Obsolete, always empty.

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

Implements