Skip to main content

Class: ListWorkflowExecutionsRequest

workflowservice.v1.ListWorkflowExecutionsRequest

Represents a ListWorkflowExecutionsRequest.

Implements#

Constructors#

constructor#

new ListWorkflowExecutionsRequest(properties?)

Constructs a new ListWorkflowExecutionsRequest.

Parameters#

NameType
properties?IListWorkflowExecutionsRequest

Properties#

namespace#

namespace: string

ListWorkflowExecutionsRequest namespace.

Implementation of#

IListWorkflowExecutionsRequest.namespace


nextPageToken#

nextPageToken: Uint8Array

ListWorkflowExecutionsRequest nextPageToken.

Implementation of#

IListWorkflowExecutionsRequest.nextPageToken


pageSize#

pageSize: number

ListWorkflowExecutionsRequest pageSize.

Implementation of#

IListWorkflowExecutionsRequest.pageSize


query#

query: string

ListWorkflowExecutionsRequest query.

Implementation of#

IListWorkflowExecutionsRequest.query

Methods#

toJSON#

toJSON(): Object

Converts this ListWorkflowExecutionsRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ListWorkflowExecutionsRequest

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

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


decodeDelimited#

Static decodeDelimited(reader): ListWorkflowExecutionsRequest

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

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ListWorkflowExecutionsRequest

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageListWorkflowExecutionsRequestListWorkflowExecutionsRequest
options?IConversionOptions-

Returns#

Object

Plain object