Class: WorkflowActivationJob
coresdk.workflow_activation.WorkflowActivationJob
Represents a WorkflowActivationJob.
Properties
cancelWorkflow
• Optional cancelWorkflow: null | $Properties
A request to cancel the workflow was received.
doUpdate
• Optional doUpdate: null | $Properties
A request to handle a workflow update.
fireTimer
• Optional fireTimer: null | $Properties
A timer has fired, allowing whatever was waiting on it (if anything) to proceed
initializeWorkflow
• Optional initializeWorkflow: null | $Properties
A workflow is starting, record all of the information from its start event
notifyHasPatch
• Optional notifyHasPatch: null | $Properties
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.
queryWorkflow
• Optional queryWorkflow: null | $Properties
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.
removeFromCache
• Optional removeFromCache: null | $Properties
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.
resolveActivity
• Optional resolveActivity: null | $Properties
An activity was resolved, result could be completed, failed or cancelled
resolveChildWorkflowExecution
• Optional resolveChildWorkflowExecution: null | $Properties
A child workflow was resolved, result could be completed or failed
resolveChildWorkflowExecutionStart
• Optional resolveChildWorkflowExecutionStart: null | $Properties
A child workflow execution has started or failed to start
resolveNexusOperation
• Optional resolveNexusOperation: null | $Properties
A nexus operation resolved.
resolveNexusOperationStart
• Optional resolveNexusOperationStart: null | $Properties
A nexus operation started.
resolveRequestCancelExternalWorkflow
• Optional resolveRequestCancelExternalWorkflow: null | $Properties
An attempt to cancel an external workflow resolved
resolveSignalExternalWorkflow
• Optional resolveSignalExternalWorkflow: null | $Properties
An attempt to signal an external workflow resolved
signalWorkflow
• Optional signalWorkflow: null | $Properties
A request to signal the workflow was received.
updateRandomSeed
• Optional updateRandomSeed: null | $Properties
Workflow was reset. The randomness seed must be updated.
variant
• Optional variant: "initializeWorkflow" | "fireTimer" | "updateRandomSeed" | "queryWorkflow" | "cancelWorkflow" | "signalWorkflow" | "resolveActivity" | "notifyHasPatch" | "resolveChildWorkflowExecutionStart" | "resolveChildWorkflowExecution" | "resolveSignalExternalWorkflow" | "resolveRequestCancelExternalWorkflow" | "doUpdate" | "resolveNexusOperationStart" | "resolveNexusOperation" | "removeFromCache"
WorkflowActivationJob variant.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowActivationJob to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowActivationJob & $Shape
Creates a new WorkflowActivationJob instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowActivationJob & $Shape
WorkflowActivationJob instance
▸ create(properties?): WorkflowActivationJob
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowActivationJob & $Shape
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 & $Shape
WorkflowActivationJob
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowActivationJob & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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