Enum Class VersionDrainageStatus

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

  • Enum Constant Details

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

    • UNRECOGNIZED

      public static final VersionDrainageStatus UNRECOGNIZED

  • Field Details

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

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

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

  • Method Details

    • values

      public static VersionDrainageStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VersionDrainageStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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 class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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 class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null