Skip to main content

Interface: IPollActivityTaskQueueResponse

workflowservice.v1.IPollActivityTaskQueueResponse

Properties of a PollActivityTaskQueueResponse.

Implemented by​

Properties​

activityId​

• Optional activityId: null | string

The autogenerated or user specified identifier of this activity. Can be used to complete the activity via RespondActivityTaskCompletedById. May be re-used as long as the last usage has resolved, but unique IDs for every activity invocation is a good idea.

activityType​

• Optional activityType: null | IActivityType

PollActivityTaskQueueResponse activityType

attempt​

• Optional attempt: null | number

Starting at 1, the number of attempts to perform this activity

currentAttemptScheduledTime​

• Optional currentAttemptScheduledTime: null | ITimestamp

When was this task attempt scheduled

• Optional header: null | IHeader

Headers specified by the scheduling workflow. Commonly used to propagate contextual info from the workflow to its activities. For example, tracing contexts.

heartbeatDetails​

• Optional heartbeatDetails: null | IPayloads

Details of the last heartbeat that was recorded for this activity as of the time this task was delivered.

heartbeatTimeout​

• Optional heartbeatTimeout: null | IDuration

Window within which the activity must report a heartbeat, or be timed out.

input​

• Optional input: null | IPayloads

Arguments to the activity invocation

retryPolicy​

• Optional retryPolicy: null | IRetryPolicy

This is the retry policy the service uses which may be different from the one provided (or not) during activity scheduling. The service can override the provided one if some values are not specified or exceed configured system limits.

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | IDuration

First scheduled -> final result reported timeout

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

scheduledTime​

• Optional scheduledTime: null | ITimestamp

When was this task first scheduled

startToCloseTimeout​

• Optional startToCloseTimeout: null | IDuration

Current attempt start -> final result reported timeout

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

startedTime​

• Optional startedTime: null | ITimestamp

When was this task started (this attempt)

taskToken​

• Optional taskToken: null | Uint8Array

A unique identifier for this task

workflowExecution​

• Optional workflowExecution: null | IWorkflowExecution

Execution info of the requesting workflow

workflowNamespace​

• Optional workflowNamespace: null | string

The namespace the workflow which requested this activity lives in

workflowType​

• Optional workflowType: null | IWorkflowType

Type of the requesting workflow