Skip to main content

Interface: IWorkflowActivation

coresdk.workflow_activation.IWorkflowActivation

Properties of a WorkflowActivation.

Hierarchy​

Properties​

availableInternalFlags​

• Optional availableInternalFlags: null | number[]

Internal flags which are available for use by lang. If is_replaying is false, all internal flags may be used. This is not a delta - all previously used flags always appear since this representation is cheap.

Inherited from​

$Properties.availableInternalFlags

continueAsNewSuggested​

• Optional continueAsNewSuggested: null | boolean

Set true if the most recent WFT started event had this suggestion

Inherited from​

$Properties.continueAsNewSuggested

deploymentVersionForCurrentTask​

• Optional deploymentVersionForCurrentTask: null | $Properties

Set to the deployment version of the worker that processed this task, which may be empty. During replay this version may not equal the version of the replaying worker. If not replaying and this worker has a defined Deployment Version, it will equal that. It will also be empty for evict-only activations. The deployment name may be empty, but not the build id, if this worker was using the deprecated Build ID-only feature(s).

Inherited from​

$Properties.deploymentVersionForCurrentTask

historyLength​

• Optional historyLength: null | number

Current history length as determined by the event id of the most recently processed event. This ensures that the number is always deterministic

Inherited from​

$Properties.historyLength

historySizeBytes​

• Optional historySizeBytes: null | Long

The history size in bytes as of the last WFT started event

Inherited from​

$Properties.historySizeBytes

isReplaying​

• Optional isReplaying: null | boolean

Whether or not the activation is replaying past events

Inherited from​

$Properties.isReplaying

jobs​

• Optional jobs: null | $Properties[]

The things to do upon activating the workflow

Inherited from​

$Properties.jobs

lastSdkVersion​

• Optional lastSdkVersion: null | string

The last seen SDK version from the most recent WFT completed event

Inherited from​

$Properties.lastSdkVersion

runId​

• Optional runId: null | string

The id of the currently active run of the workflow. Also used as a cache key. There may only ever be one active workflow task (and hence activation) of a run at one time.

Inherited from​

$Properties.runId

suggestContinueAsNewReasons​

• Optional suggestContinueAsNewReasons: null | SuggestContinueAsNewReason[]

Experimental. Optionally decide the versioning behavior that the first task of the new run should use. For example, choose to AutoUpgrade on continue-as-new instead of inheriting the pinned version of the previous run.

Inherited from​

$Properties.suggestContinueAsNewReasons

targetWorkerDeploymentVersionChanged​

• Optional targetWorkerDeploymentVersionChanged: null | boolean

True if Workflow's Target Worker Deployment Version is different from its Pinned Version and the workflow is Pinned. Experimental.

Inherited from​

$Properties.targetWorkerDeploymentVersionChanged

timestamp​

• Optional timestamp: null | $Properties

The current time as understood by the workflow, which is set by workflow task started events

Inherited from​

$Properties.timestamp