Skip to main content

Interface: $Properties

v1.PollActivityTaskQueueResponse.$Properties

Properties of a PollActivityTaskQueueResponse.

Hierarchy​

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. Note that only a workflow activity ID may be autogenerated.

activityRunId​

• Optional activityRunId: null | string

The run ID of the activity execution, only set for standalone activities.

activityType​

• Optional activityType: null | $Properties

PollActivityTaskQueueResponse activityType

attempt​

• Optional attempt: null | number

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

currentAttemptScheduledTime​

• Optional currentAttemptScheduledTime: null | $Properties

When was this task attempt scheduled

• Optional header: null | $Properties

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 | $Properties

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

heartbeatTimeout​

• Optional heartbeatTimeout: null | $Properties

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

input​

• Optional input: null | $Properties

Arguments to the activity invocation

pollerGroupInfos​

• Optional pollerGroupInfos: null | $Properties[]

The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to:

  1. Maintain minimum number of pollers no less than the number of groups.
  2. Try to assign the next poll to a group without any pending polls,
  3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.

pollerGroupsInfo​

• Optional pollerGroupsInfo: null | $Properties

The weighted, versioned list of poller groups IDs that client should use for future polls to this task queue. Client should ignore this if it has already applied a snapshot with a version greater than or equal to poller_groups_info.version. Client is expected to:

  1. Maintain minimum number of pollers no less than the number of groups.
  2. Try to assign the next poll to a group without any pending polls,
  3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.

pollerScalingDecision​

• Optional pollerScalingDecision: null | $Properties

Server-advised information the SDK may use to adjust its poller count.

priority​

• Optional priority: null | $Properties

Priority metadata

retryPolicy​

• Optional retryPolicy: null | $Properties

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 | $Properties

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 | $Properties

When was this task first scheduled

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

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 | $Properties

When was this task started (this attempt)

taskToken​

• Optional taskToken: null | Uint8Array

A unique identifier for this task

workflowExecution​

• Optional workflowExecution: null | $Properties

Execution info of the requesting workflow (if this is a workflow activity)

workflowNamespace​

• Optional workflowNamespace: null | string

The namespace of the activity. If this is a workflow activity then this is the namespace of the workflow also. If this is a standalone activity then the name of this field is misleading, but retained for compatibility with workflow activities.

workflowType​

• Optional workflowType: null | $Properties

Type of the requesting workflow (if this is a workflow activity).