Class: ScheduleAction
Represents a ScheduleAction.
Implements
Constructors
constructor
• new ScheduleAction(properties?): ScheduleAction
Constructs a new ScheduleAction.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IScheduleAction | Properties to set |
Returns
Properties
action
• Optional action: "startWorkflow"
ScheduleAction action.
startWorkflow
• Optional startWorkflow: null | INewWorkflowExecutionInfo
All fields of NewWorkflowExecutionInfo are valid except for:
- workflow_id_reuse_policy
- cron_schedule The workflow id of the started workflow may not match this exactly, it may have a timestamp appended for uniqueness.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ScheduleAction to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ScheduleAction
Creates a new ScheduleAction instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IScheduleAction | Properties to set |
Returns
ScheduleAction instance
decode
▸ decode(reader, length?): ScheduleAction
Decodes a ScheduleAction 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
ScheduleAction
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ScheduleAction
Decodes a ScheduleAction message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ScheduleAction
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 ScheduleAction message. Does not implicitly temporal.api.schedule.v1.ScheduleAction.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IScheduleAction | ScheduleAction message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ScheduleAction message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleAction.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IScheduleAction | ScheduleAction message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ScheduleAction
Creates a ScheduleAction message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ScheduleAction
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ScheduleAction
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 ScheduleAction message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ScheduleAction | ScheduleAction |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object