Class: ActivityOptions
Represents an ActivityOptions.
Properties
heartbeatTimeout
• Optional heartbeatTimeout: null | $Properties
Maximum permitted time between successful worker heartbeats.
priority
• Optional priority: null | $Properties
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
retryPolicy
• Optional retryPolicy: null | $Properties
The retry policy for the activity. Will never exceed schedule_to_close_timeout.
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | $Properties
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: null | $Properties
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. --)
startDelay
• Optional startDelay: null | $Properties
Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.
When updated, the time is added to the original schedule_time, not to the current time.
If the resulting time is in the past, the task is made available for dispatch immediately.
startToCloseTimeout
• Optional startToCloseTimeout: null | $Properties
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: null | $Properties
ActivityOptions taskQueue.
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityOptions & $Properties
Creates a new ActivityOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ActivityOptions instance
▸ create(properties?): ActivityOptions
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ActivityOptions & $Properties
Decodes an ActivityOptions 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
ActivityOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityOptions & $Properties
Decodes an ActivityOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityOptions
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 ActivityOptions message. Does not implicitly temporal.api.activity.v1.ActivityOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ActivityOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityOptions message, length delimited. Does not implicitly temporal.api.activity.v1.ActivityOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ActivityOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityOptions
Creates an ActivityOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityOptions
toObject
▸ toObject(message, options?): Object
Creates a plain object from an ActivityOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityOptions | ActivityOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object