Skip to main content

Class: ListWorkflowExecutionsRequest

workflowservice.v1.ListWorkflowExecutionsRequest

Represents a ListWorkflowExecutionsRequest.

Properties

namespace

namespace: string

ListWorkflowExecutionsRequest namespace.


nextPageToken

nextPageToken: Uint8Array

ListWorkflowExecutionsRequest nextPageToken.


pageSize

pageSize: number

ListWorkflowExecutionsRequest pageSize.


query

query: string

ListWorkflowExecutionsRequest query.

Methods

toJSON

toJSON(): Object

Converts this ListWorkflowExecutionsRequest to JSON.

Returns

Object

JSON object


create

create(properties?): ListWorkflowExecutionsRequest & $Properties

Creates a new ListWorkflowExecutionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

ListWorkflowExecutionsRequest & $Properties

ListWorkflowExecutionsRequest instance

create(properties?): ListWorkflowExecutionsRequest

Parameters

NameType
properties?$Properties

Returns

ListWorkflowExecutionsRequest


decode

decode(reader, length?): ListWorkflowExecutionsRequest & $Properties

Decodes a ListWorkflowExecutionsRequest message from the specified reader or buffer.

Parameters

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

Returns

ListWorkflowExecutionsRequest & $Properties

ListWorkflowExecutionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ListWorkflowExecutionsRequest & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ListWorkflowExecutionsRequest & $Properties

ListWorkflowExecutionsRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesListWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesListWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ListWorkflowExecutionsRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageListWorkflowExecutionsRequestListWorkflowExecutionsRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object