Interface: IActivityTaskScheduledEventAttributes
history.v1.IActivityTaskScheduledEventAttributes
Properties of an ActivityTaskScheduledEventAttributes.
Implemented by
Properties
activityId
• Optional
activityId: null
| string
The worker/user assigned identifier for the activity
activityType
• Optional
activityType: null
| IActivityType
ActivityTaskScheduledEventAttributes activityType
header
• Optional
header: null
| IHeader
ActivityTaskScheduledEventAttributes header
heartbeatTimeout
• Optional
heartbeatTimeout: null
| IDuration
Maximum permitted time between successful worker heartbeats.
input
• Optional
input: null
| IPayloads
ActivityTaskScheduledEventAttributes input
retryPolicy
• Optional
retryPolicy: null
| IRetryPolicy
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.
scheduleToCloseTimeout
• Optional
scheduleToCloseTimeout: null
| IDuration
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. --)
scheduleToStartTimeout
• Optional
scheduleToStartTimeout: null
| IDuration
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. --)
startToCloseTimeout
• Optional
startToCloseTimeout: null
| IDuration
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. --)
taskQueue
• Optional
taskQueue: null
| ITaskQueue
ActivityTaskScheduledEventAttributes taskQueue
useCompatibleVersion
• Optional
useCompatibleVersion: null
| boolean
If this is set, the workflow executing this command wishes to start the activity using a version compatible with the version that this workflow most recently ran on, if such behavior is possible.
workflowTaskCompletedEventId
• Optional
workflowTaskCompletedEventId: null
| Long
The WORKFLOW_TASK_COMPLETED
event which this command was reported with