Class: RespondWorkflowTaskCompletedRequest

workflowservice.v1.RespondWorkflowTaskCompletedRequest

Represents a RespondWorkflowTaskCompletedRequest.

Properties

binaryChecksum

• binaryChecksum: string

Deprecated. Use deployment_options instead. Worker process' unique binary id

---

capabilities

• Optional capabilities: null | $Properties

All capabilities the SDK supports.

---

commands

• commands: $Properties[]

A list of commands generated when driving the workflow code in response to the new task

---

deployment

• Optional deployment: null | $Properties

Deployment info of the worker that completed this task. Must be present if user has set WorkerDeploymentOptions regardless of versioning being enabled or not. Deprecated. Replaced with deployment_options.

---

deploymentOptions

• Optional deploymentOptions: null | $Properties

Worker deployment options that user has set in the worker.

---

forceCreateNewWorkflowTask

• forceCreateNewWorkflowTask: boolean

Can be used to force creation of a new workflow task, even if no commands have resolved or one would not otherwise have been generated. This is used when the worker knows it is doing something useful, but cannot complete it within the workflow task timeout. Local activities which run for longer than the task timeout being the prime example.

---

identity

• identity: string

The identity of the worker/client

---

intermediatePage

• intermediatePage: boolean

True for non-final pages of a paginated workflow task completion. The final page's page_number tells the server how many intermediate pages (0..page_number-1) preceded it. May only be used when the namespace capability workflow_task_completion_pagination is true.

---

messages

• messages: $Properties[]

Protocol messages piggybacking on a WFT as a transport

---

meteringMetadata

• Optional meteringMetadata: null | $Properties

Local usage data collected for metering

---

namespace

• namespace: string

RespondWorkflowTaskCompletedRequest namespace.

---

pageNumber

• pageNumber: number

0-indexed page number when the workflow task completion is split across multiple requests ("pages"). 0 for single-page requests. May only be set to non-zero value when the namespace capability workflow_task_completion_pagination is true.

---

queryResults

• queryResults: Object

Responses to the queries field in the task being responded to

Index signature

▪ [k: string]: $Properties

---

resourceId

• resourceId: string

Resource ID for routing. Contains the workflow ID from the original task.

---

returnNewWorkflowTask

• returnNewWorkflowTask: boolean

If set, the worker wishes to immediately receive the next workflow task as a response to this completion. This can save on polling round-trips.

---

sdkMetadata

• Optional sdkMetadata: null | $Properties

Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.

---

stickyAttributes

• Optional stickyAttributes: null | $Properties

May be set by workers to indicate that the worker desires future tasks to be provided with incremental history on a sticky queue.

---

taskToken

• taskToken: Uint8Array

The task token as received in PollWorkflowTaskQueueResponse

---

versioningBehavior

• versioningBehavior: VersioningBehavior

Versioning behavior of this workflow execution as set on the worker that completed this task. UNSPECIFIED means versioning is not enabled in the worker.

---

workerControlTaskQueue

• workerControlTaskQueue: string

A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.

---

workerInstanceKey

• workerInstanceKey: string

A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.

---

workerVersionStamp

• Optional workerVersionStamp: null | $Properties

Version info of the worker who processed this task. This message's build_id field should always be set by SDKs. Workers opting into versioning will also set the use_versioning field to true. See message docstrings for more. Deprecated. Use deployment_options and versioning_behavior instead.

Methods

toJSON

▸ toJSON(): Object

Converts this RespondWorkflowTaskCompletedRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RespondWorkflowTaskCompletedRequest & $Shape

Creates a new RespondWorkflowTaskCompletedRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Shape	Properties to set

Returns

RespondWorkflowTaskCompletedRequest & $Shape

RespondWorkflowTaskCompletedRequest instance

▸ create(properties?): RespondWorkflowTaskCompletedRequest

Parameters

Name	Type
properties?	$Properties

Returns

RespondWorkflowTaskCompletedRequest

---

decode

▸ decode(reader, length?): RespondWorkflowTaskCompletedRequest & $Shape

Decodes a RespondWorkflowTaskCompletedRequest 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

RespondWorkflowTaskCompletedRequest & $Shape

RespondWorkflowTaskCompletedRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RespondWorkflowTaskCompletedRequest & $Shape

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

Parameters

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

Returns

RespondWorkflowTaskCompletedRequest & $Shape

RespondWorkflowTaskCompletedRequest

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 RespondWorkflowTaskCompletedRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.verify|verify messages.

Parameters

Name	Type	Description
message	$Properties	RespondWorkflowTaskCompletedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	RespondWorkflowTaskCompletedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RespondWorkflowTaskCompletedRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RespondWorkflowTaskCompletedRequest

RespondWorkflowTaskCompletedRequest

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	RespondWorkflowTaskCompletedRequest	RespondWorkflowTaskCompletedRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object