Skip to main content

Class: ScheduleListInfo

schedule.v1.ScheduleListInfo

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

Implements

Constructors

constructor

new ScheduleListInfo(properties?): ScheduleListInfo

Constructs a new ScheduleListInfo.

Parameters

NameTypeDescription
properties?IScheduleListInfoProperties to set

Returns

ScheduleListInfo

Properties

futureActionTimes

futureActionTimes: ITimestamp[]

ScheduleListInfo futureActionTimes.

Implementation of

IScheduleListInfo.futureActionTimes


notes

notes: string

From state:

Implementation of

IScheduleListInfo.notes


paused

paused: boolean

ScheduleListInfo paused.

Implementation of

IScheduleListInfo.paused


recentActions

recentActions: IScheduleActionResult[]

From info (maybe fewer entries):

Implementation of

IScheduleListInfo.recentActions


spec

Optional spec: null | IScheduleSpec

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

Implementation of

IScheduleListInfo.spec


workflowType

Optional workflowType: null | IWorkflowType

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:

Implementation of

IScheduleListInfo.workflowType

Methods

toJSON

toJSON(): Object

Converts this ScheduleListInfo to JSON.

Returns

Object

JSON object


create

create(properties?): ScheduleListInfo

Creates a new ScheduleListInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IScheduleListInfoProperties to set

Returns

ScheduleListInfo

ScheduleListInfo instance


decode

decode(reader, length?): ScheduleListInfo

Decodes a ScheduleListInfo message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ScheduleListInfo

ScheduleListInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ScheduleListInfo

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ScheduleListInfo

ScheduleListInfo

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

Parameters

NameTypeDescription
messageIScheduleListInfoScheduleListInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIScheduleListInfoScheduleListInfo message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ScheduleListInfo

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ScheduleListInfo

ScheduleListInfo


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleListInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageScheduleListInfoScheduleListInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object