Skip to main content

Class: ScanWorkflowExecutionsResponse

workflowservice.v1.ScanWorkflowExecutionsResponse

Represents a ScanWorkflowExecutionsResponse.

Implements#

Constructors#

constructor#

new ScanWorkflowExecutionsResponse(properties?)

Constructs a new ScanWorkflowExecutionsResponse.

Parameters#

NameType
properties?IScanWorkflowExecutionsResponse

Properties#

executions#

executions: IWorkflowExecutionInfo[]

ScanWorkflowExecutionsResponse executions.

Implementation of#

IScanWorkflowExecutionsResponse.executions


nextPageToken#

nextPageToken: Uint8Array

ScanWorkflowExecutionsResponse nextPageToken.

Implementation of#

IScanWorkflowExecutionsResponse.nextPageToken

Methods#

toJSON#

toJSON(): Object

Converts this ScanWorkflowExecutionsResponse to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ScanWorkflowExecutionsResponse

Decodes a ScanWorkflowExecutionsResponse message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse


decodeDelimited#

Static decodeDelimited(reader): ScanWorkflowExecutionsResponse

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse


encode#

Static encode(message, writer?): Writer

Encodes the specified ScanWorkflowExecutionsResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.ScanWorkflowExecutionsResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIScanWorkflowExecutionsResponseScanWorkflowExecutionsResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified ScanWorkflowExecutionsResponse message, length delimited. Does not implicitly {@link temporal.api.workflowservice.v1.ScanWorkflowExecutionsResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIScanWorkflowExecutionsResponseScanWorkflowExecutionsResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ScanWorkflowExecutionsResponse

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageScanWorkflowExecutionsResponseScanWorkflowExecutionsResponse
options?IConversionOptions-

Returns#

Object

Plain object