Package io.temporal.api.enums.v1

Enum BuildIdTaskReachability

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

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

    • Field Detail

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

    • Method Detail

      • values

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

      • valueOf

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