Skip to main content

Class: ScanWorkflowExecutionsRequest

workflowservice.v1.ScanWorkflowExecutionsRequest

Represents a ScanWorkflowExecutionsRequest.

Implements#

Constructors#

constructor#

new ScanWorkflowExecutionsRequest(properties?)

Constructs a new ScanWorkflowExecutionsRequest.

Parameters#

NameType
properties?IScanWorkflowExecutionsRequest

Properties#

namespace#

namespace: string

ScanWorkflowExecutionsRequest namespace.

Implementation of#

IScanWorkflowExecutionsRequest.namespace


nextPageToken#

nextPageToken: Uint8Array

ScanWorkflowExecutionsRequest nextPageToken.

Implementation of#

IScanWorkflowExecutionsRequest.nextPageToken


pageSize#

pageSize: number

ScanWorkflowExecutionsRequest pageSize.

Implementation of#

IScanWorkflowExecutionsRequest.pageSize


query#

query: string

ScanWorkflowExecutionsRequest query.

Implementation of#

IScanWorkflowExecutionsRequest.query

Methods#

toJSON#

toJSON(): Object

Converts this ScanWorkflowExecutionsRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ScanWorkflowExecutionsRequest

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

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest


decodeDelimited#

Static decodeDelimited(reader): ScanWorkflowExecutionsRequest

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

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ScanWorkflowExecutionsRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageScanWorkflowExecutionsRequestScanWorkflowExecutionsRequest
options?IConversionOptions-

Returns#

Object

Plain object