Skip to main content

Class: ScheduleListInfo

ScheduleListInfo is an abbreviated set of values from Schedule and ScheduleInfo that's returned in ListSchedules.

Properties​

futureActionTimes​

futureActionTimes: $Properties[]

ScheduleListInfo futureActionTimes.

notes​

notes: string

From state:

paused​

paused: boolean

ScheduleListInfo paused.

recentActions​

recentActions: $Properties[]

From info (maybe fewer entries):

spec?​

optional spec?: $Properties | null

From spec: Some fields are dropped from this copy of spec: timezone_data

stateSizeBytes​

stateSizeBytes: Long

Size of the schedule's internal state (including payloads) in bytes.

workflowType?​

optional workflowType?: $Properties | null

From action: Action is a oneof field, but we need to encode this in JSON and oneof fields don't work well with JSON. If action is start_workflow, this is set:

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleListInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleListInfo & $Properties

Creates a new ScheduleListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleListInfo & $Properties

ScheduleListInfo instance

Call Signature​

static create(properties?): ScheduleListInfo

Creates a new ScheduleListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleListInfo

ScheduleListInfo instance

decode()​

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

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

ScheduleListInfo & $Properties

ScheduleListInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleListInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleListInfo & $Properties

ScheduleListInfo

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

Parameters​

message​

$Properties

ScheduleListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ScheduleListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleListInfo

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

Parameters​

object​

Plain object

Returns​

ScheduleListInfo

ScheduleListInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ScheduleListInfo

ScheduleListInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object