Skip to main content

Class: ScheduleActionResult

Represents a ScheduleActionResult.

Properties​

actualTime?​

optional actualTime?: $Properties | null

Time that the action was taken (real time).

scheduleTime?​

optional scheduleTime?: $Properties | null

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

startWorkflowResult?​

optional startWorkflowResult?: $Properties | null

If action was start_workflow:

startWorkflowStatus​

startWorkflowStatus: WorkflowExecutionStatus

If the action was start_workflow, this field will reflect an eventually-consistent view of the started workflow's status.

Methods​

toJSON()​

toJSON(): object

Converts this ScheduleActionResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ScheduleActionResult & $Properties

Creates a new ScheduleActionResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleActionResult & $Properties

ScheduleActionResult instance

Call Signature​

static create(properties?): ScheduleActionResult

Creates a new ScheduleActionResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ScheduleActionResult

ScheduleActionResult instance

decode()​

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

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

ScheduleActionResult & $Properties

ScheduleActionResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ScheduleActionResult & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ScheduleActionResult & $Properties

ScheduleActionResult

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

Parameters​

message​

$Properties

ScheduleActionResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ScheduleActionResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ScheduleActionResult

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

Parameters​

object​

Plain object

Returns​

ScheduleActionResult

ScheduleActionResult

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ScheduleActionResult

ScheduleActionResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object