Enum Class BuildIdTaskReachability

java.lang.Object
java.lang.Enum<BuildIdTaskReachability>
io.temporal.api.enums.v1.BuildIdTaskReachability
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<BuildIdTaskReachability>, Constable
@Generated(value="protoc", comments="annotations:BuildIdTaskReachability.java.pb.meta") public enum BuildIdTaskReachability extends Enum<BuildIdTaskReachability> implements com.google.protobuf.ProtocolMessageEnum
 Specifies which category of tasks may reach a versioned worker of a certain Build ID.

 Task Reachability is eventually consistent; there may be a delay (up to few minutes) until it
 converges to the most accurate value but it is designed in a way to take the more conservative
 side until it converges. For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.

 Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be
 accounted for reachability as server cannot know if they'll happen as they do not use
 assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows
 who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make
 sure to query reachability for the parent/previous workflow's Task Queue as well.
Protobuf enum temporal.api.enums.v1.BuildIdTaskReachability

  • Enum Constant Details

    • BUILD_ID_TASK_REACHABILITY_UNSPECIFIED

      public static final BuildIdTaskReachability BUILD_ID_TASK_REACHABILITY_UNSPECIFIED
       Task reachability is not reported
      BUILD_ID_TASK_REACHABILITY_UNSPECIFIED = 0;

    • BUILD_ID_TASK_REACHABILITY_REACHABLE

      public static final BuildIdTaskReachability BUILD_ID_TASK_REACHABILITY_REACHABLE
       Build ID may be used by new workflows or activities (base on versioning rules), or there MAY
 be open workflows or backlogged activities assigned to it.
      BUILD_ID_TASK_REACHABILITY_REACHABLE = 1;

    • BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY

      public static final BuildIdTaskReachability BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY
       Build ID does not have open workflows and is not reachable by new workflows,
 but MAY have closed workflows within the namespace retention period.
 Not applicable to activity-only task queues.
      BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY = 2;

    • BUILD_ID_TASK_REACHABILITY_UNREACHABLE

      public static final BuildIdTaskReachability BUILD_ID_TASK_REACHABILITY_UNREACHABLE
       Build ID is not used for new executions, nor it has been used by any existing execution
 within the retention period.
      BUILD_ID_TASK_REACHABILITY_UNREACHABLE = 3;

    • UNRECOGNIZED

      public static final BuildIdTaskReachability UNRECOGNIZED

  • Field Details

    • BUILD_ID_TASK_REACHABILITY_UNSPECIFIED_VALUE

      public static final int BUILD_ID_TASK_REACHABILITY_UNSPECIFIED_VALUE
       Task reachability is not reported
      BUILD_ID_TASK_REACHABILITY_UNSPECIFIED = 0;
      See Also:

    • BUILD_ID_TASK_REACHABILITY_REACHABLE_VALUE

      public static final int BUILD_ID_TASK_REACHABILITY_REACHABLE_VALUE
       Build ID may be used by new workflows or activities (base on versioning rules), or there MAY
 be open workflows or backlogged activities assigned to it.
      BUILD_ID_TASK_REACHABILITY_REACHABLE = 1;
      See Also:

    • BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY_VALUE

      public static final int BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY_VALUE
       Build ID does not have open workflows and is not reachable by new workflows,
 but MAY have closed workflows within the namespace retention period.
 Not applicable to activity-only task queues.
      BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY = 2;
      See Also:

    • BUILD_ID_TASK_REACHABILITY_UNREACHABLE_VALUE

      public static final int BUILD_ID_TASK_REACHABILITY_UNREACHABLE_VALUE
       Build ID is not used for new executions, nor it has been used by any existing execution
 within the retention period.
      BUILD_ID_TASK_REACHABILITY_UNREACHABLE = 3;
      See Also:

  • Method Details

    • values

      public static BuildIdTaskReachability[] 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 BuildIdTaskReachability 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 BuildIdTaskReachability 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 BuildIdTaskReachability 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<BuildIdTaskReachability> 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 BuildIdTaskReachability 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