Class: ScheduleInfo

schedule.v1.ScheduleInfo

Represents a ScheduleInfo.

Implements

• IScheduleInfo

Constructors

constructor

• new ScheduleInfo(properties?): ScheduleInfo

Constructs a new ScheduleInfo.

Parameters

Name	Type	Description
properties?	IScheduleInfo	Properties to set

Returns

ScheduleInfo

Properties

actionCount

• actionCount: Long

Number of actions taken so far.

Implementation of

IScheduleInfo.actionCount

---

bufferDropped

• bufferDropped: Long

Number of dropped actions due to buffer limit.

Implementation of

IScheduleInfo.bufferDropped

---

bufferSize

• bufferSize: Long

Number of actions in the buffer. The buffer holds the actions that cannot be immediately triggered (due to the overlap policy). These actions can be a result of the normal schedule or a backfill.

Implementation of

IScheduleInfo.bufferSize

---

createTime

• Optional createTime: null | ITimestamp

Timestamps of schedule creation and last update.

Implementation of

IScheduleInfo.createTime

---

futureActionTimes

• futureActionTimes: ITimestamp[]

Next ten scheduled action times.

Implementation of

IScheduleInfo.futureActionTimes

---

invalidScheduleError

• invalidScheduleError: string

ScheduleInfo invalidScheduleError.

Implementation of

IScheduleInfo.invalidScheduleError

---

missedCatchupWindow

• missedCatchupWindow: Long

Number of times a scheduled action was skipped due to missing the catchup window.

Implementation of

IScheduleInfo.missedCatchupWindow

---

overlapSkipped

• overlapSkipped: Long

Number of skipped actions due to overlap.

Implementation of

IScheduleInfo.overlapSkipped

---

recentActions

• recentActions: IScheduleActionResult[]

Most recent ten actual action times (including manual triggers).

Implementation of

IScheduleInfo.recentActions

---

runningWorkflows

• runningWorkflows: IWorkflowExecution[]

Currently-running workflows started by this schedule. (There might be more than one if the overlap policy allows overlaps.) Note that the run_ids in here are the original execution run ids as started by the schedule. If the workflows retried, did continue-as-new, or were reset, they might still be running but with a different run_id.

Implementation of

IScheduleInfo.runningWorkflows

---

updateTime

• Optional updateTime: null | ITimestamp

ScheduleInfo updateTime.

Implementation of

IScheduleInfo.updateTime

Methods

toJSON

▸ toJSON(): Object

Converts this ScheduleInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ScheduleInfo

Creates a new ScheduleInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IScheduleInfo	Properties to set

Returns

ScheduleInfo

ScheduleInfo instance

---

decode

▸ decode(reader, length?): ScheduleInfo

Decodes a ScheduleInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

ScheduleInfo

ScheduleInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ScheduleInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

ScheduleInfo

ScheduleInfo

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

Parameters

Name	Type	Description
message	IScheduleInfo	ScheduleInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IScheduleInfo	ScheduleInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ScheduleInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ScheduleInfo

ScheduleInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	ScheduleInfo	ScheduleInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object