Skip to main content

Interface: $Properties

Properties of a WorkflowActivation.

Extended by​

Properties​

availableInternalFlags?​

optional availableInternalFlags?: number[] | null

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.

continueAsNewSuggested?​

optional continueAsNewSuggested?: boolean | null

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

deploymentVersionForCurrentTask?​

optional deploymentVersionForCurrentTask?: $Properties | null

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).

historyLength?​

optional historyLength?: number | null

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

historySizeBytes?​

optional historySizeBytes?: Long | null

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

isReplaying?​

optional isReplaying?: boolean | null

Whether or not the activation is replaying past events

jobs?​

optional jobs?: $Properties[] | null

The things to do upon activating the workflow

lastSdkVersion?​

optional lastSdkVersion?: string | null

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

runId?​

optional runId?: string | null

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.

suggestContinueAsNewReasons?​

optional suggestContinueAsNewReasons?: SuggestContinueAsNewReason[] | null

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.

targetWorkerDeploymentVersionChanged?​

optional targetWorkerDeploymentVersionChanged?: boolean | null

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

timestamp?​

optional timestamp?: $Properties | null

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