Skip to main content

Interface: IScheduleLocalActivity

Properties of a ScheduleLocalActivity.

Extends​

Properties​

activityId?​

optional activityId?: string | null

ScheduleLocalActivity activityId

Inherited from​

$Properties.activityId

activityType?​

optional activityType?: string | null

ScheduleLocalActivity activityType

Inherited from​

$Properties.activityType

arguments?​

optional arguments?: $Properties[] | null

Arguments/input to the activity.

Inherited from​

$Properties.arguments

attempt?​

optional attempt?: number | null

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.

Inherited from​

$Properties.attempt

cancellationType?​

optional cancellationType?: ActivityCancellationType | null

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.

Inherited from​

$Properties.cancellationType

headers?​

optional headers?: {[k: string]: $Properties; } | null

ScheduleLocalActivity headers

Inherited from​

$Properties.headers

includeArgumentsInMarker?​

optional includeArgumentsInMarker?: boolean | null

If set, the local activity arguments will be included in the resulting marker under the input key. This is disabled by default to avoid increasing history size unless the lang SDK explicitly chooses to expose it.

Inherited from​

$Properties.includeArgumentsInMarker

localRetryThreshold?​

optional localRetryThreshold?: $Properties | null

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.

Inherited from​

$Properties.localRetryThreshold

originalScheduleTime?​

optional originalScheduleTime?: $Properties | null

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

Inherited from​

$Properties.originalScheduleTime

retryPolicy?​

optional retryPolicy?: $Properties | null

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

Inherited from​

$Properties.retryPolicy

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

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).

Inherited from​

$Properties.scheduleToCloseTimeout

scheduleToStartTimeout?​

optional scheduleToStartTimeout?: $Properties | null

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.

Inherited from​

$Properties.scheduleToStartTimeout

seq?​

optional seq?: number | null

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

Inherited from​

$Properties.seq

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

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.

Inherited from​

$Properties.startToCloseTimeout