Skip to main content

Class: RespondQueryTaskCompletedRequest

Represents a 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.

completedType​

completedType: QueryResultType

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

failure?​

optional failure?: $Properties | null

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.

namespace​

namespace: string

RespondQueryTaskCompletedRequest namespace.

pollerGroupId​

pollerGroupId: string

Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.

queryResult?​

optional queryResult?: $Properties | null

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

taskToken​

taskToken: Uint8Array

RespondQueryTaskCompletedRequest taskToken.

Methods​

toJSON()​

toJSON(): object

Converts this RespondQueryTaskCompletedRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RespondQueryTaskCompletedRequest & $Shape

Creates a new RespondQueryTaskCompletedRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

RespondQueryTaskCompletedRequest & $Shape

RespondQueryTaskCompletedRequest instance

Call Signature​

static create(properties?): RespondQueryTaskCompletedRequest

Creates a new RespondQueryTaskCompletedRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest instance

decode()​

static decode(reader, length?): RespondQueryTaskCompletedRequest & $Shape

Decodes a RespondQueryTaskCompletedRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

RespondQueryTaskCompletedRequest & $Shape

RespondQueryTaskCompletedRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RespondQueryTaskCompletedRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RespondQueryTaskCompletedRequest & $Shape

RespondQueryTaskCompletedRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

RespondQueryTaskCompletedRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RespondQueryTaskCompletedRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RespondQueryTaskCompletedRequest

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

Parameters​

object​

Plain object

Returns​

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RespondQueryTaskCompletedRequest

RespondQueryTaskCompletedRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object