Skip to main content

Class: QueryWorkflowRequest

workflowservice.v1.QueryWorkflowRequest

Represents a QueryWorkflowRequest.

Implements

Constructors

constructor

new QueryWorkflowRequest(properties?)

Constructs a new QueryWorkflowRequest.

Parameters

NameTypeDescription
properties?IQueryWorkflowRequestProperties to set

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


create

Static create(properties?): QueryWorkflowRequest

Creates a new QueryWorkflowRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IQueryWorkflowRequestProperties to set

Returns

QueryWorkflowRequest

QueryWorkflowRequest instance


decode

Static decode(reader, length?): QueryWorkflowRequest

Decodes a QueryWorkflowRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

QueryWorkflowRequest

QueryWorkflowRequest


decodeDelimited

Static decodeDelimited(reader): QueryWorkflowRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

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 temporal.api.workflowservice.v1.QueryWorkflowRequest.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for QueryWorkflowRequest

Parameters

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

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object