Skip to main content

Interface: IActivityTaskScheduledEventAttributes

history.v1.IActivityTaskScheduledEventAttributes

Properties of an ActivityTaskScheduledEventAttributes.

Hierarchy​

  • $Properties

    ↳ IActivityTaskScheduledEventAttributes

Properties​

activityId​

• Optional activityId: null | string

The worker/user assigned identifier for the activity

Inherited from​

$Properties.activityId

activityType​

• Optional activityType: null | $Properties

ActivityTaskScheduledEventAttributes activityType

Inherited from​

$Properties.activityType

• Optional header: null | $Properties

ActivityTaskScheduledEventAttributes header

Inherited from​

$Properties.header

heartbeatTimeout​

• Optional heartbeatTimeout: null | $Properties

Maximum permitted time between successful worker heartbeats.

Inherited from​

$Properties.heartbeatTimeout

input​

• Optional input: null | $Properties

ActivityTaskScheduledEventAttributes input

Inherited from​

$Properties.input

priority​

• Optional priority: null | $Properties

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

Inherited from​

$Properties.priority

retryPolicy​

• Optional retryPolicy: null | $Properties

Activities are assigned a default retry policy controlled by the service's dynamic configuration. Retries will happen up to schedule_to_close_timeout. To disable retries set retry_policy.maximum_attempts to 1.

Inherited from​

$Properties.retryPolicy

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified.

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

Inherited from​

$Properties.scheduleToCloseTimeout

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | $Properties

Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout or workflow execution timeout if not specified.

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

Inherited from​

$Properties.scheduleToStartTimeout

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or schedule_to_close_timeout must be specified.

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

Inherited from​

$Properties.startToCloseTimeout

taskQueue​

• Optional taskQueue: null | $Properties

ActivityTaskScheduledEventAttributes taskQueue

Inherited from​

$Properties.taskQueue

useWorkflowBuildId​

• Optional useWorkflowBuildId: null | boolean

If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Inherited from​

$Properties.useWorkflowBuildId

workflowTaskCompletedEventId​

• Optional workflowTaskCompletedEventId: null | Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Inherited from​

$Properties.workflowTaskCompletedEventId