Skip to main content

Class: WorkflowQueryResult

Answer to a WorkflowQuery

Properties​

answer?​

optional answer?: $Properties | null

Set when the query succeeds with the results. Mutually exclusive with error_message and failure.

errorMessage​

errorMessage: string

Mutually exclusive with answer. Set when the query fails. See also the newer failure field.

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 answer. Set when the query fails.

resultType​

resultType: QueryResultType

Did the query succeed or fail?

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowQueryResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowQueryResult & $Shape

Creates a new WorkflowQueryResult instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowQueryResult & $Shape

WorkflowQueryResult instance

Call Signature​

static create(properties?): WorkflowQueryResult

Creates a new WorkflowQueryResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowQueryResult

WorkflowQueryResult instance

decode()​

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

Decodes a WorkflowQueryResult 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​

WorkflowQueryResult & $Shape

WorkflowQueryResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowQueryResult & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowQueryResult & $Shape

WorkflowQueryResult

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

Parameters​

message​

$Properties

WorkflowQueryResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowQueryResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowQueryResult

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

Parameters​

object​

Plain object

Returns​

WorkflowQueryResult

WorkflowQueryResult

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowQueryResult

WorkflowQueryResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object