Skip to main content

Interface: $Properties

Properties of an ActivityTaskScheduledEventAttributes.

Extended by​

Properties​

activityId?​

optional activityId?: string | null

The worker/user assigned identifier for the activity

activityType?​

optional activityType?: $Properties | null

ActivityTaskScheduledEventAttributes activityType

optional header?: $Properties | null

ActivityTaskScheduledEventAttributes header

heartbeatTimeout?​

optional heartbeatTimeout?: $Properties | null

Maximum permitted time between successful worker heartbeats.

input?​

optional input?: $Properties | null

ActivityTaskScheduledEventAttributes input

priority?​

optional priority?: $Properties | null

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

retryPolicy?​

optional retryPolicy?: $Properties | null

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?: $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 must be specified.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

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.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

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?: $Properties | null

ActivityTaskScheduledEventAttributes taskQueue

useWorkflowBuildId?​

optional useWorkflowBuildId?: boolean | null

If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

workflowTaskCompletedEventId?​

optional workflowTaskCompletedEventId?: Long | null

The WORKFLOW_TASK_COMPLETED event which this command was reported with