Skip to main content

Class: ListOpenWorkflowExecutionsRequest

workflowservice.v1.ListOpenWorkflowExecutionsRequest

Represents a ListOpenWorkflowExecutionsRequest.

Properties​

executionFilter​

• Optional executionFilter: null | $Properties

ListOpenWorkflowExecutionsRequest executionFilter.


filters​

• Optional filters: "executionFilter" | "typeFilter"

ListOpenWorkflowExecutionsRequest filters.


maximumPageSize​

• maximumPageSize: number

ListOpenWorkflowExecutionsRequest maximumPageSize.


namespace​

• namespace: string

ListOpenWorkflowExecutionsRequest namespace.


nextPageToken​

• nextPageToken: Uint8Array

ListOpenWorkflowExecutionsRequest nextPageToken.


startTimeFilter​

• Optional startTimeFilter: null | $Properties

ListOpenWorkflowExecutionsRequest startTimeFilter.


typeFilter​

• Optional typeFilter: null | $Properties

ListOpenWorkflowExecutionsRequest typeFilter.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ListOpenWorkflowExecutionsRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ListOpenWorkflowExecutionsRequest & $Shape

Creates a new ListOpenWorkflowExecutionsRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

ListOpenWorkflowExecutionsRequest & $Shape

ListOpenWorkflowExecutionsRequest instance

▸ create(properties?): ListOpenWorkflowExecutionsRequest

Parameters​

NameType
properties?$Properties

Returns​

ListOpenWorkflowExecutionsRequest


decode​

▸ decode(reader, length?): ListOpenWorkflowExecutionsRequest & $Shape

Decodes a ListOpenWorkflowExecutionsRequest message from the specified reader or buffer.

Parameters​

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

Returns​

ListOpenWorkflowExecutionsRequest & $Shape

ListOpenWorkflowExecutionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ListOpenWorkflowExecutionsRequest & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ListOpenWorkflowExecutionsRequest & $Shape

ListOpenWorkflowExecutionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified ListOpenWorkflowExecutionsRequest message. Does not implicitly temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesListOpenWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesListOpenWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ListOpenWorkflowExecutionsRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageListOpenWorkflowExecutionsRequestListOpenWorkflowExecutionsRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object