Skip to main content

Class: WorkflowActivationJob

Represents a WorkflowActivationJob.

Properties​

cancelWorkflow?​

optional cancelWorkflow?: $Properties | null

A request to cancel the workflow was received.

doUpdate?​

optional doUpdate?: $Properties | null

A request to handle a workflow update.

fireTimer?​

optional fireTimer?: $Properties | null

A timer has fired, allowing whatever was waiting on it (if anything) to proceed

initializeWorkflow?​

optional initializeWorkflow?: $Properties | null

A workflow is starting, record all of the information from its start event

notifyHasPatch?​

optional notifyHasPatch?: $Properties | null

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?: $Properties | null

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?: $Properties | null

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?: $Properties | null

An activity was resolved, result could be completed, failed or cancelled

resolveChildWorkflowExecution?​

optional resolveChildWorkflowExecution?: $Properties | null

A child workflow was resolved, result could be completed or failed

resolveChildWorkflowExecutionStart?​

optional resolveChildWorkflowExecutionStart?: $Properties | null

A child workflow execution has started or failed to start

resolveNexusOperation?​

optional resolveNexusOperation?: $Properties | null

A nexus operation resolved.

resolveNexusOperationStart?​

optional resolveNexusOperationStart?: $Properties | null

A nexus operation started.

resolveRequestCancelExternalWorkflow?​

optional resolveRequestCancelExternalWorkflow?: $Properties | null

An attempt to cancel an external workflow resolved

resolveSignalExternalWorkflow?​

optional resolveSignalExternalWorkflow?: $Properties | null

An attempt to signal an external workflow resolved

signalWorkflow?​

optional signalWorkflow?: $Properties | null

A request to signal the workflow was received.

updateRandomSeed?​

optional updateRandomSeed?: $Properties | null

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()​

Call Signature​

static create(properties?): WorkflowActivationJob & $Shape

Creates a new WorkflowActivationJob instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowActivationJob & $Shape

WorkflowActivationJob instance

Call Signature​

static create(properties?): WorkflowActivationJob

Creates a new WorkflowActivationJob instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowActivationJob

WorkflowActivationJob instance

decode()​

static decode(reader, length?): WorkflowActivationJob & $Shape

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

WorkflowActivationJob & $Shape

WorkflowActivationJob

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowActivationJob & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified WorkflowActivationJob message. Does not implicitly coresdk.workflow_activation.WorkflowActivationJob.verify|verify messages.

Parameters​

message​

$Properties

WorkflowActivationJob message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowActivationJob message, length delimited. Does not implicitly coresdk.workflow_activation.WorkflowActivationJob.verify|verify messages.

Parameters​

message​

$Properties

WorkflowActivationJob message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowActivationJob

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

WorkflowActivationJob

WorkflowActivationJob

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowActivationJob

WorkflowActivationJob

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object