Skip to main content

Interface: IScheduleActivity

coresdk.workflow_commands.IScheduleActivity

Properties of a ScheduleActivity.

Implemented by#

Properties#

activityId#

Optional activityId: null | string

ScheduleActivity activityId


activityType#

Optional activityType: null | string

ScheduleActivity activityType


arguments#

Optional arguments: null | IPayload[]

Arguments/input to the activity. Called "input" upstream.


cancellationType#

Optional cancellationType: null | ActivityCancellationType

Defines behaviour of the underlying workflow when activity cancellation has been requested.


headerFields#

Optional headerFields: null | { [k: string]: IPayload; }

ScheduleActivity headerFields


heartbeatTimeout#

Optional heartbeatTimeout: null | IDuration

Maximum time allowed between successful worker heartbeats.


namespace#

Optional namespace: null | string

ScheduleActivity namespace


retryPolicy#

Optional retryPolicy: null | IRetryPolicy

retry_policy.maximum_attempts to 2.


scheduleToCloseTimeout#

Optional scheduleToCloseTimeout: null | IDuration

When not specified defaults to the workflow execution timeout.


scheduleToStartTimeout#

Optional scheduleToStartTimeout: null | IDuration

queue. Defaults to schedule_to_close_timeout or workflow execution timeout if not specified.


seq#

Optional seq: null | number

Lang's incremental sequence number, used as the operation identifier


startToCloseTimeout#

Optional startToCloseTimeout: null | IDuration

always retryable. Either this or schedule_to_close_timeout must be specified.


taskQueue#

Optional taskQueue: null | string

ScheduleActivity taskQueue