Class: ScheduleActionResult
schedule.v1.ScheduleActionResult
Represents a ScheduleActionResult.
Implements
Constructors
constructor
• new ScheduleActionResult(properties?): ScheduleActionResult
Constructs a new ScheduleActionResult.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IScheduleActionResult | Properties to set |
Returns
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
startWorkflowStatus
• startWorkflowStatus: WorkflowExecutionStatus
If the action was start_workflow, this field will reflect an eventually-consistent view of the started workflow's status.
Implementation of
IScheduleActionResult.startWorkflowStatus
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
| Name | Type | Description |
|---|---|---|
properties? | IScheduleActionResult | Properties to set |
Returns
ScheduleActionResult instance
decode
▸ decode(reader, length?): ScheduleActionResult
Decodes a ScheduleActionResult 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
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IScheduleActionResult | ScheduleActionResult message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IScheduleActionResult | ScheduleActionResult message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ScheduleActionResult
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ScheduleActionResult
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 ScheduleActionResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ScheduleActionResult | ScheduleActionResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object