Skip to main content

Class: ListOpenWorkflowExecutionsRequest

Represents a ListOpenWorkflowExecutionsRequest.

Properties​

executionFilter?​

optional executionFilter?: $Properties | null

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?: $Properties | null

ListOpenWorkflowExecutionsRequest startTimeFilter.

typeFilter?​

optional typeFilter?: $Properties | null

ListOpenWorkflowExecutionsRequest typeFilter.

Methods​

toJSON()​

toJSON(): object

Converts this ListOpenWorkflowExecutionsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListOpenWorkflowExecutionsRequest & $Shape

Creates a new ListOpenWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ListOpenWorkflowExecutionsRequest & $Shape

ListOpenWorkflowExecutionsRequest instance

Call Signature​

static create(properties?): ListOpenWorkflowExecutionsRequest

Creates a new ListOpenWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest instance

decode()​

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

Decodes a ListOpenWorkflowExecutionsRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message 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()​

static decodeDelimited(reader): ListOpenWorkflowExecutionsRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

ListOpenWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListOpenWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListOpenWorkflowExecutionsRequest

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

Parameters​

object​

Plain object

Returns​

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object