Skip to main content

Class: ScheduleListEntry

schedule.v1.ScheduleListEntry

ScheduleListEntry is returned by ListSchedules.

Properties​

info​

• Optional info: null | $Properties

ScheduleListEntry info.


memo​

• Optional memo: null | $Properties

ScheduleListEntry memo.


scheduleId​

• scheduleId: string

ScheduleListEntry scheduleId.


searchAttributes​

• Optional searchAttributes: null | $Properties

ScheduleListEntry searchAttributes.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ScheduleListEntry to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ScheduleListEntry & $Properties

Creates a new ScheduleListEntry instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

ScheduleListEntry & $Properties

ScheduleListEntry instance

▸ create(properties?): ScheduleListEntry

Parameters​

NameType
properties?$Properties

Returns​

ScheduleListEntry


decode​

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

Decodes a ScheduleListEntry message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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​

▸ decodeDelimited(reader): ScheduleListEntry & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader 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​

▸ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesScheduleListEntry message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesScheduleListEntry message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ScheduleListEntry

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ScheduleListEntry

ScheduleListEntry


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageScheduleListEntryScheduleListEntry
options?IConversionOptionsConversion options

Returns​

Object

Plain object