Class: ScheduleActivityTaskCommandAttributes

command.v1.ScheduleActivityTaskCommandAttributes

Represents a ScheduleActivityTaskCommandAttributes.

Implements

• IScheduleActivityTaskCommandAttributes

Constructors

constructor

• new ScheduleActivityTaskCommandAttributes(properties?): ScheduleActivityTaskCommandAttributes

Constructs a new ScheduleActivityTaskCommandAttributes.

Parameters

Name	Type	Description
properties?	IScheduleActivityTaskCommandAttributes	Properties to set

Returns

ScheduleActivityTaskCommandAttributes

Properties

activityId

• activityId: string

ScheduleActivityTaskCommandAttributes activityId.

Implementation of

IScheduleActivityTaskCommandAttributes.activityId

---

activityType

• Optional activityType: null | IActivityType

ScheduleActivityTaskCommandAttributes activityType.

Implementation of

IScheduleActivityTaskCommandAttributes.activityType

---

header

• Optional header: null | IHeader

ScheduleActivityTaskCommandAttributes header.

Implementation of

IScheduleActivityTaskCommandAttributes.header

---

heartbeatTimeout

• Optional heartbeatTimeout: null | IDuration

Maximum permitted time between successful worker heartbeats.

Implementation of

IScheduleActivityTaskCommandAttributes.heartbeatTimeout

---

input

• Optional input: null | IPayloads

ScheduleActivityTaskCommandAttributes input.

Implementation of

IScheduleActivityTaskCommandAttributes.input

---

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.

Implementation of

IScheduleActivityTaskCommandAttributes.requestEagerExecution

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

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.

Implementation of

IScheduleActivityTaskCommandAttributes.retryPolicy

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | IDuration

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

Implementation of

IScheduleActivityTaskCommandAttributes.scheduleToCloseTimeout

---

scheduleToStartTimeout

• Optional scheduleToStartTimeout: null | IDuration

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

Implementation of

IScheduleActivityTaskCommandAttributes.scheduleToStartTimeout

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

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

Implementation of

IScheduleActivityTaskCommandAttributes.startToCloseTimeout

---

taskQueue

• Optional taskQueue: null | ITaskQueue

ScheduleActivityTaskCommandAttributes taskQueue.

Implementation of

IScheduleActivityTaskCommandAttributes.taskQueue

---

useCompatibleVersion

• useCompatibleVersion: boolean

If this is set, the workflow executing this command wishes to start the activity using a version compatible with the version that this workflow most recently ran on, if such behavior is possible.

Implementation of

IScheduleActivityTaskCommandAttributes.useCompatibleVersion

Methods

toJSON

▸ toJSON(): Object

Converts this ScheduleActivityTaskCommandAttributes to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ScheduleActivityTaskCommandAttributes

Creates a new ScheduleActivityTaskCommandAttributes instance using the specified properties.

Parameters

Name	Type	Description
properties?	IScheduleActivityTaskCommandAttributes	Properties to set

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes instance

---

decode

▸ decode(reader, length?): ScheduleActivityTaskCommandAttributes

Decodes a ScheduleActivityTaskCommandAttributes message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ScheduleActivityTaskCommandAttributes

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IScheduleActivityTaskCommandAttributes	ScheduleActivityTaskCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IScheduleActivityTaskCommandAttributes	ScheduleActivityTaskCommandAttributes message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ScheduleActivityTaskCommandAttributes

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ScheduleActivityTaskCommandAttributes

ScheduleActivityTaskCommandAttributes

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleActivityTaskCommandAttributes

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	ScheduleActivityTaskCommandAttributes	ScheduleActivityTaskCommandAttributes
options?	IConversionOptions	Conversion options

Returns

Object

Plain object