Skip to main content

Class: ListClosedWorkflowExecutionsRequest

workflowservice.v1.ListClosedWorkflowExecutionsRequest

Represents a ListClosedWorkflowExecutionsRequest.

Implements

Constructors

constructor

new ListClosedWorkflowExecutionsRequest(properties?)

Constructs a new ListClosedWorkflowExecutionsRequest.

Parameters

NameTypeDescription
properties?IListClosedWorkflowExecutionsRequestProperties to set

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


create

Static create(properties?): ListClosedWorkflowExecutionsRequest

Creates a new ListClosedWorkflowExecutionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IListClosedWorkflowExecutionsRequestProperties to set

Returns

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest instance


decode

Static decode(reader, length?): ListClosedWorkflowExecutionsRequest

Decodes a ListClosedWorkflowExecutionsRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest


decodeDelimited

Static decodeDelimited(reader): ListClosedWorkflowExecutionsRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

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

Parameters

NameTypeDescription
messageIListClosedWorkflowExecutionsRequestListClosedWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIListClosedWorkflowExecutionsRequestListClosedWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

ListClosedWorkflowExecutionsRequest

ListClosedWorkflowExecutionsRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListClosedWorkflowExecutionsRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object