Skip to main content

Class: ListClosedWorkflowExecutionsRequest

workflowservice.v1.ListClosedWorkflowExecutionsRequest

Represents a ListClosedWorkflowExecutionsRequest.

Implements#

Constructors#

constructor#

new ListClosedWorkflowExecutionsRequest(properties?)

Constructs a new ListClosedWorkflowExecutionsRequest.

Parameters#

NameType
properties?IListClosedWorkflowExecutionsRequest

Properties#

executionFilter#

Optional executionFilter: null | IWorkflowExecutionFilter

ListClosedWorkflowExecutionsRequest executionFilter.

Implementation of#

IListClosedWorkflowExecutionsRequest.executionFilter


filters#

Optional filters: "executionFilter" | "typeFilter" | "statusFilter"

ListClosedWorkflowExecutionsRequest filters.


maximumPageSize#

maximumPageSize: number

ListClosedWorkflowExecutionsRequest maximumPageSize.

Implementation of#

IListClosedWorkflowExecutionsRequest.maximumPageSize


namespace#

namespace: string

ListClosedWorkflowExecutionsRequest namespace.

Implementation of#

IListClosedWorkflowExecutionsRequest.namespace


nextPageToken#

nextPageToken: Uint8Array

ListClosedWorkflowExecutionsRequest nextPageToken.

Implementation of#

IListClosedWorkflowExecutionsRequest.nextPageToken


startTimeFilter#

Optional startTimeFilter: null | IStartTimeFilter

ListClosedWorkflowExecutionsRequest startTimeFilter.

Implementation of#

IListClosedWorkflowExecutionsRequest.startTimeFilter


statusFilter#

Optional statusFilter: null | IStatusFilter

ListClosedWorkflowExecutionsRequest statusFilter.

Implementation of#

IListClosedWorkflowExecutionsRequest.statusFilter


typeFilter#

Optional typeFilter: null | IWorkflowTypeFilter

ListClosedWorkflowExecutionsRequest typeFilter.

Implementation of#

IListClosedWorkflowExecutionsRequest.typeFilter

Methods#

toJSON#

toJSON(): Object

Converts this ListClosedWorkflowExecutionsRequest to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ListClosedWorkflowExecutionsRequest

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

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest


decodeDelimited#

Static decodeDelimited(reader): ListClosedWorkflowExecutionsRequest

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

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageListClosedWorkflowExecutionsRequestListClosedWorkflowExecutionsRequest
options?IConversionOptions-

Returns#

Object

Plain object