Skip to main content

Class: ListArchivedWorkflowExecutionsRequest

workflowservice.v1.ListArchivedWorkflowExecutionsRequest

Represents a ListArchivedWorkflowExecutionsRequest.

Implements

Constructors

constructor

new ListArchivedWorkflowExecutionsRequest(properties?)

Constructs a new ListArchivedWorkflowExecutionsRequest.

Parameters

NameTypeDescription
properties?IListArchivedWorkflowExecutionsRequestProperties to set

Properties

namespace

namespace: string

ListArchivedWorkflowExecutionsRequest namespace.

Implementation of

IListArchivedWorkflowExecutionsRequest.namespace


nextPageToken

nextPageToken: Uint8Array

ListArchivedWorkflowExecutionsRequest nextPageToken.

Implementation of

IListArchivedWorkflowExecutionsRequest.nextPageToken


pageSize

pageSize: number

ListArchivedWorkflowExecutionsRequest pageSize.

Implementation of

IListArchivedWorkflowExecutionsRequest.pageSize


query

query: string

ListArchivedWorkflowExecutionsRequest query.

Implementation of

IListArchivedWorkflowExecutionsRequest.query

Methods

toJSON

toJSON(): Object

Converts this ListArchivedWorkflowExecutionsRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): ListArchivedWorkflowExecutionsRequest

Creates a new ListArchivedWorkflowExecutionsRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IListArchivedWorkflowExecutionsRequestProperties to set

Returns

ListArchivedWorkflowExecutionsRequest

ListArchivedWorkflowExecutionsRequest instance


decode

Static decode(reader, length?): ListArchivedWorkflowExecutionsRequest

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

ListArchivedWorkflowExecutionsRequest

ListArchivedWorkflowExecutionsRequest


decodeDelimited

Static decodeDelimited(reader): ListArchivedWorkflowExecutionsRequest

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

ListArchivedWorkflowExecutionsRequest

ListArchivedWorkflowExecutionsRequest


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): ListArchivedWorkflowExecutionsRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ListArchivedWorkflowExecutionsRequest

ListArchivedWorkflowExecutionsRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListArchivedWorkflowExecutionsRequest

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

Parameters

NameTypeDescription
messageListArchivedWorkflowExecutionsRequestListArchivedWorkflowExecutionsRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object