Class: WorkflowActivationJob
coresdk.workflow_activation.WorkflowActivationJob
Represents a WorkflowActivationJob.
Implements
Constructors
constructor
• new WorkflowActivationJob(properties?): WorkflowActivationJob
Constructs a new WorkflowActivationJob.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowActivationJob | Properties to set |
Returns
Properties
cancelWorkflow
• Optional cancelWorkflow: null | ICancelWorkflow
A request to cancel the workflow was received.
Implementation of
IWorkflowActivationJob.cancelWorkflow
doUpdate
• Optional doUpdate: null | IDoUpdate
A request to handle a workflow update.
Implementation of
IWorkflowActivationJob.doUpdate
fireTimer
• Optional fireTimer: null | IFireTimer
A timer has fired, allowing whatever was waiting on it (if anything) to proceed
Implementation of
IWorkflowActivationJob.fireTimer
notifyHasPatch
• Optional notifyHasPatch: null | INotifyHasPatch
A patch marker has been detected and lang is being told that change exists. This job is strange in that it is sent pre-emptively to lang without any corresponding command being sent first.
Implementation of
IWorkflowActivationJob.notifyHasPatch
queryWorkflow
• Optional queryWorkflow: null | IQueryWorkflow
A request to query the workflow was received. It is guaranteed that queries (one or more) always come in their own activation after other mutating jobs.
Implementation of
IWorkflowActivationJob.queryWorkflow
removeFromCache
• Optional removeFromCache: null | IRemoveFromCache
Remove the workflow identified by the [WorkflowActivation] containing this job from the cache after performing the activation. It is guaranteed that this will be the only job in the activation if present.
Implementation of
IWorkflowActivationJob.removeFromCache
resolveActivity
• Optional resolveActivity: null | IResolveActivity
An activity was resolved, result could be completed, failed or cancelled
Implementation of
IWorkflowActivationJob.resolveActivity
resolveChildWorkflowExecution
• Optional resolveChildWorkflowExecution: null | IResolveChildWorkflowExecution
A child workflow was resolved, result could be completed or failed
Implementation of
IWorkflowActivationJob.resolveChildWorkflowExecution
resolveChildWorkflowExecutionStart
• Optional resolveChildWorkflowExecutionStart: null | IResolveChildWorkflowExecutionStart
A child workflow execution has started or failed to start
Implementation of
IWorkflowActivationJob.resolveChildWorkflowExecutionStart
resolveRequestCancelExternalWorkflow
• Optional resolveRequestCancelExternalWorkflow: null | IResolveRequestCancelExternalWorkflow
An attempt to cancel an external workflow resolved
Implementation of
IWorkflowActivationJob.resolveRequestCancelExternalWorkflow
resolveSignalExternalWorkflow
• Optional resolveSignalExternalWorkflow: null | IResolveSignalExternalWorkflow
An attempt to signal an external workflow resolved
Implementation of
IWorkflowActivationJob.resolveSignalExternalWorkflow
signalWorkflow
• Optional signalWorkflow: null | ISignalWorkflow
A request to signal the workflow was received.
Implementation of
IWorkflowActivationJob.signalWorkflow
startWorkflow
• Optional startWorkflow: null | IStartWorkflow
Begin a workflow for the first time
Implementation of
IWorkflowActivationJob.startWorkflow
updateRandomSeed
• Optional updateRandomSeed: null | IUpdateRandomSeed
Workflow was reset. The randomness seed must be updated.
Implementation of
IWorkflowActivationJob.updateRandomSeed
variant
• Optional variant: "startWorkflow" | "fireTimer" | "updateRandomSeed" | "queryWorkflow" | "cancelWorkflow" | "signalWorkflow" | "resolveActivity" | "notifyHasPatch" | "resolveChildWorkflowExecutionStart" | "resolveChildWorkflowExecution" | "resolveSignalExternalWorkflow" | "resolveRequestCancelExternalWorkflow" | "doUpdate" | "removeFromCache"
WorkflowActivationJob variant.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowActivationJob to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowActivationJob
Creates a new WorkflowActivationJob instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowActivationJob | Properties to set |
Returns
WorkflowActivationJob instance
decode
▸ decode(reader, length?): WorkflowActivationJob
Decodes a WorkflowActivationJob 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
WorkflowActivationJob
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowActivationJob
Decodes a WorkflowActivationJob message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowActivationJob
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 WorkflowActivationJob message. Does not implicitly coresdk.workflow_activation.WorkflowActivationJob.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowActivationJob | WorkflowActivationJob message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowActivationJob message, length delimited. Does not implicitly coresdk.workflow_activation.WorkflowActivationJob.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowActivationJob | WorkflowActivationJob message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowActivationJob
Creates a WorkflowActivationJob message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowActivationJob
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowActivationJob
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 WorkflowActivationJob message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowActivationJob | WorkflowActivationJob |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object