Class: ScheduleActivityTaskCommandAttributes

Represents a ScheduleActivityTaskCommandAttributes.

Properties

activityId

activityId: string

ScheduleActivityTaskCommandAttributes activityId.

---

activityType?

optional activityType?: $Properties | null

ScheduleActivityTaskCommandAttributes activityType.

---

header?

optional header?: $Properties | null

ScheduleActivityTaskCommandAttributes header.

---

heartbeatTimeout?

optional heartbeatTimeout?: $Properties | null

Maximum permitted time between successful worker heartbeats.

---

input?

optional input?: $Properties | null

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

---

requestEagerExecution

requestEagerExecution: boolean

Request to start the activity directly bypassing matching service and worker polling The slot for executing the activity should be reserved when setting this field to true.

---

retryPolicy?

optional retryPolicy?: $Properties | null

Activities are provided by a default retry policy which is controlled through the service's dynamic configuration. Retries will be attempted until schedule_to_close_timeout has elapsed. 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 activity completion. The "schedule" time is when the activity is initially scheduled, not when the most recent retry is scheduled. Limits how long retries will be attempted. Either this or start_to_close_timeout must be specified. When not specified, defaults to the workflow execution timeout.

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

---

scheduleToStartTimeout?

optional scheduleToStartTimeout?: $Properties | null

Limits the time an activity task can stay in a task queue before a worker picks it up. The "schedule" time is when the most recent retry is scheduled. This timeout should usually not be set: it's useful in specific scenarios like worker-specific task queues. 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 that is not specified. More info: https://docs.temporal.io/docs/content/what-is-a-schedule-to-start-timeout/

(-- 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

ScheduleActivityTaskCommandAttributes taskQueue.

---

useWorkflowBuildId

useWorkflowBuildId: boolean

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.

Methods

toJSON()

toJSON(): object

Converts this ScheduleActivityTaskCommandAttributes to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): ScheduleActivityTaskCommandAttributes & $Properties

Creates a new ScheduleActivityTaskCommandAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ScheduleActivityTaskCommandAttributes & $Properties

ScheduleActivityTaskCommandAttributes instance

Call Signature

static create(properties?): ScheduleActivityTaskCommandAttributes

Creates a new ScheduleActivityTaskCommandAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes instance

---

decode()

static decode(reader, length?): ScheduleActivityTaskCommandAttributes & $Properties

Decodes a ScheduleActivityTaskCommandAttributes message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

ScheduleActivityTaskCommandAttributes & $Properties

ScheduleActivityTaskCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ScheduleActivityTaskCommandAttributes & $Properties

Decodes a ScheduleActivityTaskCommandAttributes message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

ScheduleActivityTaskCommandAttributes & $Properties

ScheduleActivityTaskCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified ScheduleActivityTaskCommandAttributes message. Does not implicitly temporal.api.command.v1.ScheduleActivityTaskCommandAttributes.verify|verify messages.

Parameters

message

$Properties

ScheduleActivityTaskCommandAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified ScheduleActivityTaskCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.ScheduleActivityTaskCommandAttributes.verify|verify messages.

Parameters

message

$Properties

ScheduleActivityTaskCommandAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ScheduleActivityTaskCommandAttributes

Creates a ScheduleActivityTaskCommandAttributes message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes

---

toObject()

static toObject(message, options?): object

Creates a plain object from a ScheduleActivityTaskCommandAttributes message. Also converts values to other types if specified.

Parameters

message

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes

options?

IConversionOptions

Conversion options

Returns

object

Plain object