Package io.temporal.api.enums.v1

Enum WorkerDeploymentVersionStatus

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<WorkerDeploymentVersionStatus>
    @Generated(value="protoc",
           comments="annotations:WorkerDeploymentVersionStatus.java.pb.meta")
public enum WorkerDeploymentVersionStatus
extends java.lang.Enum<WorkerDeploymentVersionStatus>
implements com.google.protobuf.ProtocolMessageEnum
     (-- api-linter: core::0216::synonyms=disabled
     aip.dev/not-precedent: Call this status because it is . --)
 Specify the status of a Worker Deployment Version.
 Experimental. Worker Deployments are experimental and might significantly change in the future.
    Protobuf enum temporal.api.enums.v1.WorkerDeploymentVersionStatus

    • Enum Constant Detail

      • WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED
        WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED = 0;

      • WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE
         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_INACTIVE = 1;

      • WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT
         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_CURRENT = 2;

      • WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING
         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_RAMPING = 3;

      • WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING
         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_DRAINING = 4;

      • WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED

        public static final WorkerDeploymentVersionStatus WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED
         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_DRAINED = 5;

    • Field Detail

      • WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED_VALUE
        WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_INACTIVE_VALUE
         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_INACTIVE = 1;
        See Also:
        Constant Field Values

      • WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_CURRENT_VALUE
         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_CURRENT = 2;
        See Also:
        Constant Field Values

      • WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_RAMPING_VALUE
         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_RAMPING = 3;
        See Also:
        Constant Field Values

      • WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_DRAINING_VALUE
         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_DRAINING = 4;
        See Also:
        Constant Field Values

      • WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED_VALUE

        public static final int WORKER_DEPLOYMENT_VERSION_STATUS_DRAINED_VALUE
         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_DRAINED = 5;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static WorkerDeploymentVersionStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (WorkerDeploymentVersionStatus c : WorkerDeploymentVersionStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static WorkerDeploymentVersionStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static WorkerDeploymentVersionStatus valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • forNumber

        public static WorkerDeploymentVersionStatus forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static WorkerDeploymentVersionStatus valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null