Skip to main content

Class: QueryWorkflowRequest

workflowservice.v1.QueryWorkflowRequest

Represents a QueryWorkflowRequest.

Implements#

Constructors#

constructor#

new QueryWorkflowRequest(properties?)

Constructs a new QueryWorkflowRequest.

Parameters#

NameType
properties?IQueryWorkflowRequest

Properties#

execution#

Optional execution: null | IWorkflowExecution

QueryWorkflowRequest execution.

Implementation of#

IQueryWorkflowRequest.execution


namespace#

namespace: string

QueryWorkflowRequest namespace.

Implementation of#

IQueryWorkflowRequest.namespace


query#

Optional query: null | IWorkflowQuery

QueryWorkflowRequest query.

Implementation of#

IQueryWorkflowRequest.query


queryRejectCondition#

queryRejectCondition: QueryRejectCondition

QueryWorkflowRequest queryRejectCondition.

Implementation of#

IQueryWorkflowRequest.queryRejectCondition

Methods#

toJSON#

toJSON(): Object

Converts this QueryWorkflowRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): QueryWorkflowRequest

Decodes a QueryWorkflowRequest 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#

QueryWorkflowRequest

QueryWorkflowRequest


decodeDelimited#

Static decodeDelimited(reader): QueryWorkflowRequest

Decodes a QueryWorkflowRequest 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#

QueryWorkflowRequest

QueryWorkflowRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): QueryWorkflowRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

QueryWorkflowRequest

QueryWorkflowRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageQueryWorkflowRequestQueryWorkflowRequest
options?IConversionOptions-

Returns#

Object

Plain object