Skip to main content

Class: ScheduleListEntry

ScheduleListEntry is returned by ListSchedules.

Properties​

info?​

optional info?: $Properties | null

ScheduleListEntry info.

memo?​

optional memo?: $Properties | null

ScheduleListEntry memo.

scheduleId​

scheduleId: string

ScheduleListEntry scheduleId.

searchAttributes?​

optional searchAttributes?: $Properties | null

ScheduleListEntry searchAttributes.

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleListEntry to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleListEntry & $Properties

Creates a new ScheduleListEntry instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleListEntry & $Properties

ScheduleListEntry instance

Call Signature​

static create(properties?): ScheduleListEntry

Creates a new ScheduleListEntry instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleListEntry

ScheduleListEntry instance

decode()​

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

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

ScheduleListEntry & $Properties

ScheduleListEntry

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleListEntry & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleListEntry & $Properties

ScheduleListEntry

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

Parameters​

message​

$Properties

ScheduleListEntry message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ScheduleListEntry message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleListEntry

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

Parameters​

object​

Plain object

Returns​

ScheduleListEntry

ScheduleListEntry

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ScheduleListEntry

ScheduleListEntry

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object