Skip to main content

Class: ListOpenWorkflowExecutionsRequest

workflowservice.v1.ListOpenWorkflowExecutionsRequest

Represents a ListOpenWorkflowExecutionsRequest.

Implements

Constructors

constructor

new ListOpenWorkflowExecutionsRequest(properties?)

Constructs a new ListOpenWorkflowExecutionsRequest.

Parameters

NameTypeDescription
properties?IListOpenWorkflowExecutionsRequestProperties to set

Properties

executionFilter

Optional executionFilter: null | IWorkflowExecutionFilter

ListOpenWorkflowExecutionsRequest executionFilter.

Implementation of

IListOpenWorkflowExecutionsRequest.executionFilter


filters

Optional filters: "executionFilter" | "typeFilter"

ListOpenWorkflowExecutionsRequest filters.


maximumPageSize

maximumPageSize: number

ListOpenWorkflowExecutionsRequest maximumPageSize.

Implementation of

IListOpenWorkflowExecutionsRequest.maximumPageSize


namespace

namespace: string

ListOpenWorkflowExecutionsRequest namespace.

Implementation of

IListOpenWorkflowExecutionsRequest.namespace


nextPageToken

nextPageToken: Uint8Array

ListOpenWorkflowExecutionsRequest nextPageToken.

Implementation of

IListOpenWorkflowExecutionsRequest.nextPageToken


startTimeFilter

Optional startTimeFilter: null | IStartTimeFilter

ListOpenWorkflowExecutionsRequest startTimeFilter.

Implementation of

IListOpenWorkflowExecutionsRequest.startTimeFilter


typeFilter

Optional typeFilter: null | IWorkflowTypeFilter

ListOpenWorkflowExecutionsRequest typeFilter.

Implementation of

IListOpenWorkflowExecutionsRequest.typeFilter

Methods

toJSON

toJSON(): Object

Converts this ListOpenWorkflowExecutionsRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): ListOpenWorkflowExecutionsRequest

Creates a new ListOpenWorkflowExecutionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IListOpenWorkflowExecutionsRequestProperties to set

Returns

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest instance


decode

Static decode(reader, length?): ListOpenWorkflowExecutionsRequest

Decodes a ListOpenWorkflowExecutionsRequest 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

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest


decodeDelimited

Static decodeDelimited(reader): ListOpenWorkflowExecutionsRequest

Decodes a ListOpenWorkflowExecutionsRequest 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

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest


encode

Static encode(message, writer?): Writer

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

Parameters

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

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

NameTypeDescription
objectObjectPlain object

Returns

ListOpenWorkflowExecutionsRequest

ListOpenWorkflowExecutionsRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListOpenWorkflowExecutionsRequest

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 ListOpenWorkflowExecutionsRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageListOpenWorkflowExecutionsRequestListOpenWorkflowExecutionsRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object