Skip to main content

Class: ListArchivedWorkflowExecutionsResponse

workflowservice.v1.ListArchivedWorkflowExecutionsResponse

Represents a ListArchivedWorkflowExecutionsResponse.

Properties​

executions​

• executions: $Properties[]

ListArchivedWorkflowExecutionsResponse executions.


nextPageToken​

• nextPageToken: Uint8Array

ListArchivedWorkflowExecutionsResponse nextPageToken.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ListArchivedWorkflowExecutionsResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ListArchivedWorkflowExecutionsResponse & $Shape

Creates a new ListArchivedWorkflowExecutionsResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

ListArchivedWorkflowExecutionsResponse & $Shape

ListArchivedWorkflowExecutionsResponse instance

▸ create(properties?): ListArchivedWorkflowExecutionsResponse

Parameters​

NameType
properties?$Properties

Returns​

ListArchivedWorkflowExecutionsResponse


decode​

▸ decode(reader, length?): ListArchivedWorkflowExecutionsResponse & $Shape

Decodes a ListArchivedWorkflowExecutionsResponse message from the specified reader or buffer.

Parameters​

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

Returns​

ListArchivedWorkflowExecutionsResponse & $Shape

ListArchivedWorkflowExecutionsResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ListArchivedWorkflowExecutionsResponse & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ListArchivedWorkflowExecutionsResponse & $Shape

ListArchivedWorkflowExecutionsResponse

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 ListArchivedWorkflowExecutionsResponse message. Does not implicitly temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsResponse.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ListArchivedWorkflowExecutionsResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ListArchivedWorkflowExecutionsResponse

ListArchivedWorkflowExecutionsResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageListArchivedWorkflowExecutionsResponseListArchivedWorkflowExecutionsResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object