Skip to main content

Class: ListActivityExecutionsRequest

Represents a ListActivityExecutionsRequest.

Properties​

namespace​

namespace: string

ListActivityExecutionsRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

Token returned in ListActivityExecutionsResponse.

pageSize​

pageSize: number

Max number of executions to return per page.

query​

query: string

Visibility query, see https://docs.temporal.io/list-filter for the syntax.

Methods​

toJSON()​

toJSON(): object

Converts this ListActivityExecutionsRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListActivityExecutionsRequest & $Properties

Creates a new ListActivityExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListActivityExecutionsRequest & $Properties

ListActivityExecutionsRequest instance

Call Signature​

static create(properties?): ListActivityExecutionsRequest

Creates a new ListActivityExecutionsRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListActivityExecutionsRequest

ListActivityExecutionsRequest instance

decode()​

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

Decodes a ListActivityExecutionsRequest 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​

ListActivityExecutionsRequest & $Properties

ListActivityExecutionsRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ListActivityExecutionsRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListActivityExecutionsRequest & $Properties

ListActivityExecutionsRequest

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

Parameters​

message​

$Properties

ListActivityExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListActivityExecutionsRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListActivityExecutionsRequest

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

Parameters​

object​

Plain object

Returns​

ListActivityExecutionsRequest

ListActivityExecutionsRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListActivityExecutionsRequest

ListActivityExecutionsRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object