Skip to main content

Class: QueryWorkflowResponse

workflowservice.v1.QueryWorkflowResponse

Represents a QueryWorkflowResponse.

Properties

Optional link: null | $Properties

Holds the link to the Workflow execution that processed the Query.


queryRejected

Optional queryRejected: null | $Properties

QueryWorkflowResponse queryRejected.


queryResult

Optional queryResult: null | $Properties

QueryWorkflowResponse queryResult.

Methods

toJSON

toJSON(): Object

Converts this QueryWorkflowResponse to JSON.

Returns

Object

JSON object


create

create(properties?): QueryWorkflowResponse & $Shape

Creates a new QueryWorkflowResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?$ShapeProperties to set

Returns

QueryWorkflowResponse & $Shape

QueryWorkflowResponse instance

create(properties?): QueryWorkflowResponse

Parameters

NameType
properties?$Properties

Returns

QueryWorkflowResponse


decode

decode(reader, length?): QueryWorkflowResponse & $Shape

Decodes a QueryWorkflowResponse message from the specified reader or buffer.

Parameters

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

Returns

QueryWorkflowResponse & $Shape

QueryWorkflowResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): QueryWorkflowResponse & $Shape

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

QueryWorkflowResponse & $Shape

QueryWorkflowResponse

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

Parameters

NameTypeDescription
message$PropertiesQueryWorkflowResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesQueryWorkflowResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): QueryWorkflowResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

QueryWorkflowResponse

QueryWorkflowResponse


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageQueryWorkflowResponseQueryWorkflowResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object