Skip to main content

Interface: $Properties

Properties of a ScheduleActivity.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

ScheduleActivity activityId

activityType?​

optional activityType?: string | null

ScheduleActivity activityType

arguments?​

optional arguments?: $Properties[] | null

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

cancellationType?​

optional cancellationType?: ActivityCancellationType | null

Defines how the workflow will wait (or not) for cancellation of the activity to be confirmed

doNotEagerlyExecute?​

optional doNotEagerlyExecute?: boolean | null

If set, the worker will not tell the service that it can immediately start executing this activity. When unset/default, workers will always attempt to do so if activity execution slots are available.

headers?​

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

ScheduleActivity headers

heartbeatTimeout?​

optional heartbeatTimeout?: $Properties | null

Maximum time allowed between successful worker heartbeats.

priority?​

optional priority?: $Properties | null

The Priority to use for this activity

retryPolicy?​

optional retryPolicy?: $Properties | null

Activities are provided by a default retry policy controlled through the service dynamic configuration. Retries are happening up to schedule_to_close_timeout. To disable retries set retry_policy.maximum_attempts to 1.

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

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_seconds must be specified. When not specified defaults to the workflow execution timeout.

scheduleToStartTimeout?​

optional scheduleToStartTimeout?: $Properties | null

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.

seq?​

optional seq?: number | null

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

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

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

taskQueue?​

optional taskQueue?: string | null

The name of the task queue to place this activity request in

versioningIntent?​

optional versioningIntent?: VersioningIntent | null

Whether this activity should run on a worker with a compatible build id or not.