Skip to main content

Class: ScanWorkflowExecutionsResponse

workflowservice.v1.ScanWorkflowExecutionsResponse

Represents a ScanWorkflowExecutionsResponse.

Implements

Constructors

constructor

new ScanWorkflowExecutionsResponse(properties?)

Constructs a new ScanWorkflowExecutionsResponse.

Parameters

NameTypeDescription
properties?IScanWorkflowExecutionsResponseProperties to set

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


create

Static create(properties?): ScanWorkflowExecutionsResponse

Creates a new ScanWorkflowExecutionsResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IScanWorkflowExecutionsResponseProperties to set

Returns

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse instance


decode

Static decode(reader, length?): ScanWorkflowExecutionsResponse

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

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse


decodeDelimited

Static decodeDelimited(reader): ScanWorkflowExecutionsResponse

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

ScanWorkflowExecutionsResponse

ScanWorkflowExecutionsResponse


encode

Static encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

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


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScanWorkflowExecutionsResponse

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

Parameters

NameTypeDescription
messageScanWorkflowExecutionsResponseScanWorkflowExecutionsResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object