Package io.temporal.api.enums.v1

Enum VersionDrainageStatus

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<VersionDrainageStatus>
    @Generated(value="protoc",
           comments="annotations:VersionDrainageStatus.java.pb.meta")
public enum VersionDrainageStatus
extends java.lang.Enum<VersionDrainageStatus>
implements com.google.protobuf.ProtocolMessageEnum
     (-- 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.
    Protobuf enum temporal.api.enums.v1.VersionDrainageStatus

    • Enum Constant Detail

      • VERSION_DRAINAGE_STATUS_UNSPECIFIED

        public static final VersionDrainageStatus VERSION_DRAINAGE_STATUS_UNSPECIFIED
         Drainage Status is not specified.
        VERSION_DRAINAGE_STATUS_UNSPECIFIED = 0;

      • VERSION_DRAINAGE_STATUS_DRAINING

        public static final VersionDrainageStatus VERSION_DRAINAGE_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.
        VERSION_DRAINAGE_STATUS_DRAINING = 1;

      • VERSION_DRAINAGE_STATUS_DRAINED

        public static final VersionDrainageStatus VERSION_DRAINAGE_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.
        VERSION_DRAINAGE_STATUS_DRAINED = 2;

    • Field Detail

      • VERSION_DRAINAGE_STATUS_UNSPECIFIED_VALUE

        public static final int VERSION_DRAINAGE_STATUS_UNSPECIFIED_VALUE
         Drainage Status is not specified.
        VERSION_DRAINAGE_STATUS_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • VERSION_DRAINAGE_STATUS_DRAINING_VALUE

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

      • VERSION_DRAINAGE_STATUS_DRAINED_VALUE

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

    • Method Detail

      • values

        public static VersionDrainageStatus[] 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 (VersionDrainageStatus c : VersionDrainageStatus.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static VersionDrainageStatus 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 VersionDrainageStatus 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 VersionDrainageStatus forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<VersionDrainageStatus> internalGetValueMap()

      • 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 VersionDrainageStatus 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