Enum VersionDrainageStatus

Namespace

Temporalio.Api.Enums.V1

Assembly

Temporalio.dll

(-- api-linter: core::0216::synonyms=disabled aip.dev/not-precedent: Call this status because it is . --) Specify the drainage status for a Worker Deployment Version so users can decide whether they can safely decommission the version. Experimental. Worker Deployments are experimental and might significantly change in the future.

public enum VersionDrainageStatus

Fields

[OriginalName("VERSION_DRAINAGE_STATUS_DRAINED")] Drained = 2

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.

[OriginalName("VERSION_DRAINAGE_STATUS_DRAINING")] Draining = 1

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

[OriginalName("VERSION_DRAINAGE_STATUS_UNSPECIFIED")] Unspecified = 0

Drainage Status is not specified.