Skip to main content

Interface: $Properties

workflow_commands.ScheduleLocalActivity.$Properties

Properties of a ScheduleLocalActivity.

Hierarchy​

Properties​

activityId​

• Optional activityId: null | string

ScheduleLocalActivity activityId

activityType​

• Optional activityType: null | string

ScheduleLocalActivity activityType

arguments​

• Optional arguments: null | $Properties[]

Arguments/input to the activity.

attempt​

• Optional attempt: null | number

Local activities can start with a non-1 attempt, if lang has been told to backoff using a timer before retrying. It should pass the attempt number from a DoBackoff activity resolution.

cancellationType​

• Optional cancellationType: null | ActivityCancellationType

Defines how the workflow will wait (or not) for cancellation of the activity to be confirmed. Lang should default this to WAIT_CANCELLATION_COMPLETED, even though proto will default to TRY_CANCEL automatically.

headers​

• Optional headers: null | { [k: string]: $Properties; }

ScheduleLocalActivity headers

localRetryThreshold​

• Optional localRetryThreshold: null | $Properties

If the activity is retrying and backoff would exceed this value, lang will be told to schedule a timer and retry the activity after. Otherwise, backoff will happen internally in core. Defaults to 1 minute.

originalScheduleTime​

• Optional originalScheduleTime: null | $Properties

If this local activity is a retry (as per the attempt field) this needs to be the original scheduling time (as provided in DoBackoff)

retryPolicy​

• Optional retryPolicy: null | $Properties

Specify a retry policy for the local activity. By default local activities will be retried indefinitely.

scheduleToCloseTimeout​

• Optional scheduleToCloseTimeout: null | $Properties

Indicates how long the caller is willing to wait for local activity completion. Limits how long retries will be attempted. When not specified defaults to the workflow execution timeout (which may be unset).

scheduleToStartTimeout​

• Optional scheduleToStartTimeout: null | $Properties

Limits time the local activity can idle internally before being executed. That can happen if the worker is currently at max concurrent local activity executions. 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 if not specified and that is set. Must be <= schedule_to_close_timeout when set, otherwise, it will be clamped down.

seq​

• Optional seq: null | number

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

startToCloseTimeout​

• Optional startToCloseTimeout: null | $Properties

Maximum time the local activity is allowed to execute after the task is dispatched. This timeout is always retryable. Either or both of schedule_to_close_timeout and this must be specified. If set, this must be <= schedule_to_close_timeout, otherwise, it will be clamped down.