Skip to main content

Class: ListSchedulesRequest

Represents a ListSchedulesRequest.

Properties​

maximumPageSize​

maximumPageSize: number

How many to return at once.

namespace​

namespace: string

The namespace to list schedules in.

nextPageToken​

nextPageToken: Uint8Array

Token to get the next page of results.

query​

query: string

Query to filter schedules.

Methods​

toJSON()​

toJSON(): object

Converts this ListSchedulesRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListSchedulesRequest & $Properties

Creates a new ListSchedulesRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListSchedulesRequest & $Properties

ListSchedulesRequest instance

Call Signature​

static create(properties?): ListSchedulesRequest

Creates a new ListSchedulesRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListSchedulesRequest

ListSchedulesRequest instance

decode()​

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

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

ListSchedulesRequest & $Properties

ListSchedulesRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ListSchedulesRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListSchedulesRequest & $Properties

ListSchedulesRequest

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

Parameters​

message​

$Properties

ListSchedulesRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListSchedulesRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListSchedulesRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ListSchedulesRequest

ListSchedulesRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListSchedulesRequest

ListSchedulesRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object