Skip to main content

Class: ScanWorkflowExecutionsRequest

Deprecated: Use with ListWorkflowExecutions.

Properties​

namespace​

namespace: string

ScanWorkflowExecutionsRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

ScanWorkflowExecutionsRequest nextPageToken.

pageSize​

pageSize: number

ScanWorkflowExecutionsRequest pageSize.

query​

query: string

ScanWorkflowExecutionsRequest query.

Methods​

toJSON()​

toJSON(): object

Converts this ScanWorkflowExecutionsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScanWorkflowExecutionsRequest & $Properties

Creates a new ScanWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScanWorkflowExecutionsRequest & $Properties

ScanWorkflowExecutionsRequest instance

Call Signature​

static create(properties?): ScanWorkflowExecutionsRequest

Creates a new ScanWorkflowExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest instance

decode()​

static decode(reader, length?): ScanWorkflowExecutionsRequest & $Properties

Decodes a ScanWorkflowExecutionsRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ScanWorkflowExecutionsRequest & $Properties

ScanWorkflowExecutionsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScanWorkflowExecutionsRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScanWorkflowExecutionsRequest & $Properties

ScanWorkflowExecutionsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

ScanWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ScanWorkflowExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScanWorkflowExecutionsRequest

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

Parameters​

object​

Plain object

Returns​

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ScanWorkflowExecutionsRequest

ScanWorkflowExecutionsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object