Class: RespondWorkflowTaskCompletedRequest

workflowservice.v1.RespondWorkflowTaskCompletedRequest

Represents a RespondWorkflowTaskCompletedRequest.

Implements

• IRespondWorkflowTaskCompletedRequest

Constructors

constructor

• new RespondWorkflowTaskCompletedRequest(properties?): RespondWorkflowTaskCompletedRequest

Constructs a new RespondWorkflowTaskCompletedRequest.

Parameters

Name	Type	Description
properties?	IRespondWorkflowTaskCompletedRequest	Properties to set

Returns

RespondWorkflowTaskCompletedRequest

Properties

binaryChecksum

• binaryChecksum: string

DEPRECATED since 1.21 - use worker_version_stamp instead. Worker process' unique binary id

Implementation of

IRespondWorkflowTaskCompletedRequest.binaryChecksum

---

capabilities

• Optional capabilities: null | ICapabilities

All capabilities the SDK supports.

Implementation of

IRespondWorkflowTaskCompletedRequest.capabilities

---

commands

• commands: ICommand[]

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

Implementation of

IRespondWorkflowTaskCompletedRequest.commands

---

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.

Implementation of

IRespondWorkflowTaskCompletedRequest.forceCreateNewWorkflowTask

---

identity

• identity: string

The identity of the worker/client

Implementation of

IRespondWorkflowTaskCompletedRequest.identity

---

messages

• messages: IMessage[]

Protocol messages piggybacking on a WFT as a transport

Implementation of

IRespondWorkflowTaskCompletedRequest.messages

---

meteringMetadata

• Optional meteringMetadata: null | IMeteringMetadata

Local usage data collected for metering

Implementation of

IRespondWorkflowTaskCompletedRequest.meteringMetadata

---

namespace

• namespace: string

RespondWorkflowTaskCompletedRequest namespace.

Implementation of

IRespondWorkflowTaskCompletedRequest.namespace

---

queryResults

• queryResults: Object

Responses to the queries field in the task being responded to

Index signature

▪ [k: string]: IWorkflowQueryResult

Implementation of

IRespondWorkflowTaskCompletedRequest.queryResults

---

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.

Implementation of

IRespondWorkflowTaskCompletedRequest.returnNewWorkflowTask

---

sdkMetadata

• Optional sdkMetadata: null | IWorkflowTaskCompletedMetadata

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

Implementation of

IRespondWorkflowTaskCompletedRequest.sdkMetadata

---

stickyAttributes

• Optional stickyAttributes: null | IStickyExecutionAttributes

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

Implementation of

IRespondWorkflowTaskCompletedRequest.stickyAttributes

---

taskToken

• taskToken: Uint8Array

The task token as received in PollWorkflowTaskQueueResponse

Implementation of

IRespondWorkflowTaskCompletedRequest.taskToken

---

workerVersionStamp

• Optional workerVersionStamp: null | IWorkerVersionStamp

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.

Implementation of

IRespondWorkflowTaskCompletedRequest.workerVersionStamp

Methods

toJSON

▸ toJSON(): Object

Converts this RespondWorkflowTaskCompletedRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RespondWorkflowTaskCompletedRequest

Creates a new RespondWorkflowTaskCompletedRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IRespondWorkflowTaskCompletedRequest	Properties to set

Returns

RespondWorkflowTaskCompletedRequest

RespondWorkflowTaskCompletedRequest instance

---

decode

▸ decode(reader, length?): RespondWorkflowTaskCompletedRequest

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

RespondWorkflowTaskCompletedRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RespondWorkflowTaskCompletedRequest

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

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

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RespondWorkflowTaskCompletedRequest

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