Skip to main content

Enumeration: WorkerDeploymentVersionStatus

(-- api-linter: core::0216::synonyms=disabled aip.dev/not-precedent: Call this status because it is . --) Specify the status of a Worker Deployment Version.

Enumeration Members​

WORKER_DEPLOYMENT_VERSION_STATUS_CREATED​

WORKER_DEPLOYMENT_VERSION_STATUS_CREATED: 6

The Worker Deployment Version is created by user (via CreateWorkerDeploymentVersion API) but server has not seen any poller for it yet.

WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT​

WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT: 2

The Worker Deployment Version is the current version of the Worker Deployment. All new workflow executions and tasks of existing unversioned or AutoUpgrade workflows are routed to this version.

WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED​

WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED: 5

The Worker Deployment Version is not used by new or open workflows, but might be still needed by Queries sent to closed workflows. The version can be decommissioned safely if user does not query closed workflows. If the user does query closed workflows for some time x after workflows are closed, they should decommission the version after it has been drained for that duration.

WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING​

WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING: 4

The Worker Deployment Version is not used by new workflows but is still used by open pinned workflows. The version cannot be decommissioned safely.

WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE​

WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE: 1

The Worker Deployment Version has been created inside the Worker Deployment but is not used by any workflow executions. These Versions can still have workflows if they have an explicit Versioning Override targeting this Version. Such Versioning Override could be set at workflow start time, or at a later time via UpdateWorkflowExecutionOptions.

WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING​

WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING: 3

The Worker Deployment Version is the ramping version of the Worker Deployment. A subset of new Pinned workflow executions are routed to this version. Moreover, a portion of existing unversioned or AutoUpgrade workflow executions are also routed to this version.

WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED​

WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED: 0

WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED value