Skip to main content

Class: ListWorkflowExecutionsRequest

workflowservice.v1.ListWorkflowExecutionsRequest

Represents a ListWorkflowExecutionsRequest.

Implements

Constructors

constructor

new ListWorkflowExecutionsRequest(properties?)

Constructs a new ListWorkflowExecutionsRequest.

Parameters

NameTypeDescription
properties?IListWorkflowExecutionsRequestProperties to set

Properties

namespace

namespace: string

ListWorkflowExecutionsRequest namespace.

Implementation of

IListWorkflowExecutionsRequest.namespace


nextPageToken

nextPageToken: Uint8Array

ListWorkflowExecutionsRequest nextPageToken.

Implementation of

IListWorkflowExecutionsRequest.nextPageToken


pageSize

pageSize: number

ListWorkflowExecutionsRequest pageSize.

Implementation of

IListWorkflowExecutionsRequest.pageSize


query

query: string

ListWorkflowExecutionsRequest query.

Implementation of

IListWorkflowExecutionsRequest.query

Methods

toJSON

toJSON(): Object

Converts this ListWorkflowExecutionsRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): ListWorkflowExecutionsRequest

Creates a new ListWorkflowExecutionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IListWorkflowExecutionsRequestProperties to set

Returns

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest instance


decode

Static decode(reader, length?): ListWorkflowExecutionsRequest

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

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


decodeDelimited

Static decodeDelimited(reader): ListWorkflowExecutionsRequest

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

ListWorkflowExecutionsRequest

ListWorkflowExecutionsRequest


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIListWorkflowExecutionsRequestListWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIListWorkflowExecutionsRequestListWorkflowExecutionsRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

Static 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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListWorkflowExecutionsRequest

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

Parameters

NameTypeDescription
messageListWorkflowExecutionsRequestListWorkflowExecutionsRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object