Skip to main content

Class: ScheduleActionResult

schedule.v1.ScheduleActionResult

Represents a ScheduleActionResult.

Implements​

Constructors​

constructor​

β€’ new ScheduleActionResult(properties?): ScheduleActionResult

Constructs a new ScheduleActionResult.

Parameters​

NameTypeDescription
properties?IScheduleActionResultProperties to set

Returns​

ScheduleActionResult

Properties​

actualTime​

β€’ Optional actualTime: null | ITimestamp

Time that the action was taken (real time).

Implementation of​

IScheduleActionResult.actualTime


scheduleTime​

β€’ Optional scheduleTime: null | ITimestamp

Time that the action was taken (according to the schedule, including jitter).

Implementation of​

IScheduleActionResult.scheduleTime


startWorkflowResult​

β€’ Optional startWorkflowResult: null | IWorkflowExecution

If action was start_workflow:

Implementation of​

IScheduleActionResult.startWorkflowResult

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this ScheduleActionResult to JSON.

Returns​

Object

JSON object


create​

β–Έ create(properties?): ScheduleActionResult

Creates a new ScheduleActionResult instance using the specified properties.

Parameters​

NameTypeDescription
properties?IScheduleActionResultProperties to set

Returns​

ScheduleActionResult

ScheduleActionResult instance


decode​

β–Έ decode(reader, length?): ScheduleActionResult

Decodes a ScheduleActionResult message from the specified reader or buffer.

Parameters​

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

Returns​

ScheduleActionResult

ScheduleActionResult

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

β–Έ decodeDelimited(reader): ScheduleActionResult

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ScheduleActionResult

ScheduleActionResult

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

β–Έ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

β–Έ fromObject(object): ScheduleActionResult

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ScheduleActionResult

ScheduleActionResult


getTypeUrl​

β–Έ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ScheduleActionResult

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 ScheduleActionResult message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageScheduleActionResultScheduleActionResult
options?IConversionOptionsConversion options

Returns​

Object

Plain object