Skip to main content

Class: WorkflowQuery

query.v1.WorkflowQuery

Represents a WorkflowQuery.

Implements#

Constructors#

constructor#

new WorkflowQuery(properties?)

Constructs a new WorkflowQuery.

Parameters#

NameType
properties?IWorkflowQuery

Properties#

queryArgs#

Optional queryArgs: null | IPayloads

WorkflowQuery queryArgs.

Implementation of#

IWorkflowQuery.queryArgs


queryType#

queryType: string

WorkflowQuery queryType.

Implementation of#

IWorkflowQuery.queryType

Methods#

toJSON#

toJSON(): Object

Converts this WorkflowQuery to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WorkflowQuery

Decodes a WorkflowQuery message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

WorkflowQuery

WorkflowQuery


decodeDelimited#

Static decodeDelimited(reader): WorkflowQuery

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

WorkflowQuery

WorkflowQuery


encode#

Static encode(message, writer?): Writer

Encodes the specified WorkflowQuery message. Does not implicitly {@link temporal.api.query.v1.WorkflowQuery.verify|verify} messages.

Parameters#

NameTypeDescription
messageIWorkflowQueryWorkflowQuery message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowQuery message, length delimited. Does not implicitly {@link temporal.api.query.v1.WorkflowQuery.verify|verify} messages.

Parameters#

NameTypeDescription
messageIWorkflowQueryWorkflowQuery message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WorkflowQuery

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WorkflowQuery

WorkflowQuery


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWorkflowQueryWorkflowQuery
options?IConversionOptions-

Returns#

Object

Plain object