Class: RespondQueryTaskCompletedRequest

workflowservice.v1.RespondQueryTaskCompletedRequest

Represents a RespondQueryTaskCompletedRequest.

Implements

• IRespondQueryTaskCompletedRequest

Constructors

constructor

• new RespondQueryTaskCompletedRequest(properties?): RespondQueryTaskCompletedRequest

Constructs a new RespondQueryTaskCompletedRequest.

Parameters

Name	Type	Description
properties?	IRespondQueryTaskCompletedRequest	Properties to set

Returns

RespondQueryTaskCompletedRequest

Properties

cause

• cause: WorkflowTaskFailedCause

Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses. See the type's doc for more.

Implementation of

IRespondQueryTaskCompletedRequest.cause

---

completedType

• completedType: QueryResultType

RespondQueryTaskCompletedRequest completedType.

Implementation of

IRespondQueryTaskCompletedRequest.completedType

---

errorMessage

• errorMessage: string

A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED. SDKs should also fill in the more complete failure field to provide the full context and support encryption of failure information. error_message will be duplicated if the failure field is present to support callers that pre-date the addition of that field, regardless of whether or not a custom failure converter is used. Mutually exclusive with query_result. Set when the query fails.

Implementation of

IRespondQueryTaskCompletedRequest.errorMessage

---

failure

• Optional failure: null | IFailure

The full reason for this query failure. This field is newer than error_message and can be encoded by the SDK's failure converter to support E2E encryption of messages and stack traces. Mutually exclusive with query_result. Set when the query fails.

Implementation of

IRespondQueryTaskCompletedRequest.failure

---

namespace

• namespace: string

RespondQueryTaskCompletedRequest namespace.

Implementation of

IRespondQueryTaskCompletedRequest.namespace

---

queryResult

• Optional queryResult: null | IPayloads

The result of the query. Mutually exclusive with error_message and failure. Set when the query succeeds.

Implementation of

IRespondQueryTaskCompletedRequest.queryResult

---

taskToken

• taskToken: Uint8Array

RespondQueryTaskCompletedRequest taskToken.

Implementation of

IRespondQueryTaskCompletedRequest.taskToken

Methods

toJSON

▸ toJSON(): Object

Converts this RespondQueryTaskCompletedRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): RespondQueryTaskCompletedRequest

Creates a new RespondQueryTaskCompletedRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IRespondQueryTaskCompletedRequest	Properties to set

Returns

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest instance

---

decode

▸ decode(reader, length?): RespondQueryTaskCompletedRequest

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

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): RespondQueryTaskCompletedRequest

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

Parameters

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

Returns

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest

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

Parameters

Name	Type	Description
message	IRespondQueryTaskCompletedRequest	RespondQueryTaskCompletedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IRespondQueryTaskCompletedRequest	RespondQueryTaskCompletedRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): RespondQueryTaskCompletedRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RespondQueryTaskCompletedRequest

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 RespondQueryTaskCompletedRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	RespondQueryTaskCompletedRequest	RespondQueryTaskCompletedRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object