Skip to main content

Class: WorkflowQueryResult

query.v1.WorkflowQueryResult

Answer to a WorkflowQuery

Implements

Constructors

constructor

new WorkflowQueryResult(properties?): WorkflowQueryResult

Constructs a new WorkflowQueryResult.

Parameters

NameTypeDescription
properties?IWorkflowQueryResultProperties to set

Returns

WorkflowQueryResult

Properties

answer

Optional answer: null | IPayloads

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

Implementation of

IWorkflowQueryResult.answer


errorMessage

errorMessage: string

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

Implementation of

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

Implementation of

IWorkflowQueryResult.failure


resultType

resultType: QueryResultType

Did the query succeed or fail?

Implementation of

IWorkflowQueryResult.resultType

Methods

toJSON

toJSON(): Object

Converts this WorkflowQueryResult to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowQueryResult

Creates a new WorkflowQueryResult instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowQueryResultProperties to set

Returns

WorkflowQueryResult

WorkflowQueryResult instance


decode

decode(reader, length?): WorkflowQueryResult

Decodes a WorkflowQueryResult message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

WorkflowQueryResult

WorkflowQueryResult

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowQueryResult

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowQueryResult

WorkflowQueryResult

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

Parameters

NameTypeDescription
messageIWorkflowQueryResultWorkflowQueryResult message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIWorkflowQueryResultWorkflowQueryResult message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowQueryResult

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowQueryResult

WorkflowQueryResult


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowQueryResult

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkflowQueryResultWorkflowQueryResult
options?IConversionOptionsConversion options

Returns

Object

Plain object