Skip to main content

Class: ListClosedWorkflowExecutionsRequest

Represents a ListClosedWorkflowExecutionsRequest.

Properties​

executionFilter?​

optional executionFilter?: $Properties | null

ListClosedWorkflowExecutionsRequest executionFilter.

filters?​

optional filters?: "executionFilter" | "typeFilter" | "statusFilter"

ListClosedWorkflowExecutionsRequest filters.

maximumPageSize​

maximumPageSize: number

ListClosedWorkflowExecutionsRequest maximumPageSize.

namespace​

namespace: string

ListClosedWorkflowExecutionsRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

ListClosedWorkflowExecutionsRequest nextPageToken.

startTimeFilter?​

optional startTimeFilter?: $Properties | null

ListClosedWorkflowExecutionsRequest startTimeFilter.

statusFilter?​

optional statusFilter?: $Properties | null

ListClosedWorkflowExecutionsRequest statusFilter.

typeFilter?​

optional typeFilter?: $Properties | null

ListClosedWorkflowExecutionsRequest typeFilter.

Methods​

toJSON()​

toJSON(): object

Converts this ListClosedWorkflowExecutionsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListClosedWorkflowExecutionsRequest & $Shape

Creates a new ListClosedWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ListClosedWorkflowExecutionsRequest & $Shape

ListClosedWorkflowExecutionsRequest instance

Call Signature​

static create(properties?): ListClosedWorkflowExecutionsRequest

Creates a new ListClosedWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest instance

decode()​

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

Decodes a ListClosedWorkflowExecutionsRequest 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​

ListClosedWorkflowExecutionsRequest & $Shape

ListClosedWorkflowExecutionsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ListClosedWorkflowExecutionsRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListClosedWorkflowExecutionsRequest & $Shape

ListClosedWorkflowExecutionsRequest

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 ListClosedWorkflowExecutionsRequest message. Does not implicitly temporal.api.workflowservice.v1.ListClosedWorkflowExecutionsRequest.verify|verify messages.

Parameters​

message​

$Properties

ListClosedWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListClosedWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListClosedWorkflowExecutionsRequest

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

Parameters​

object​

Plain object

Returns​

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object