io.temporal.api.enums.v1.BuildIdTaskReachability Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of temporal-serviceclient Show documentation
Temporal Workflow Java SDK
There is a newer version: 1.27.0
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: temporal/api/enums/v1/task_queue.proto

package io.temporal.api.enums.v1;

/**
 *  * 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 {@code temporal.api.enums.v1.BuildIdTaskReachability}
 */
@javax.annotation.Generated(value="protoc", comments="annotations:BuildIdTaskReachability.java.pb.meta")
public enum BuildIdTaskReachability
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   *    * Task reachability is not reported
   * 
   *
   * BUILD_ID_TASK_REACHABILITY_UNSPECIFIED = 0;
   */
  BUILD_ID_TASK_REACHABILITY_UNSPECIFIED(0),
  /**
   *    * 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_REACHABLE(1),
  /**
   *    * 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_CLOSED_WORKFLOWS_ONLY(2),
  /**
   *    * 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;
   */
  BUILD_ID_TASK_REACHABILITY_UNREACHABLE(3),
  UNRECOGNIZED(-1),
  ;

  /**
   *    * Task reachability is not reported
   * 
   *
   * BUILD_ID_TASK_REACHABILITY_UNSPECIFIED = 0;
   */
  public static final int BUILD_ID_TASK_REACHABILITY_UNSPECIFIED_VALUE = 0;
  /**
   *    * 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;
   */
  public static final int BUILD_ID_TASK_REACHABILITY_REACHABLE_VALUE = 1;
  /**
   *    * 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;
   */
  public static final int BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY_VALUE = 2;
  /**
   *    * 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;
   */
  public static final int BUILD_ID_TASK_REACHABILITY_UNREACHABLE_VALUE = 3;


  public final int getNumber() {
    if (this == UNRECOGNIZED) {
      throw new java.lang.IllegalArgumentException(
          "Can't get the number of an unknown enum value.");
    }
    return value;
  }

  /**
   * @param value The numeric wire value of the corresponding enum entry.
   * @return The enum associated with the given numeric wire value.
   * @deprecated Use {@link #forNumber(int)} instead.
   */
  @java.lang.Deprecated
  public static BuildIdTaskReachability valueOf(int value) {
    return forNumber(value);
  }

  /**
   * @param value The numeric wire value of the corresponding enum entry.
   * @return The enum associated with the given numeric wire value.
   */
  public static BuildIdTaskReachability forNumber(int value) {
    switch (value) {
      case 0: return BUILD_ID_TASK_REACHABILITY_UNSPECIFIED;
      case 1: return BUILD_ID_TASK_REACHABILITY_REACHABLE;
      case 2: return BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY;
      case 3: return BUILD_ID_TASK_REACHABILITY_UNREACHABLE;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      BuildIdTaskReachability> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public BuildIdTaskReachability findValueByNumber(int number) {
            return BuildIdTaskReachability.forNumber(number);
          }
        };

  public final com.google.protobuf.Descriptors.EnumValueDescriptor
      getValueDescriptor() {
    return getDescriptor().getValues().get(ordinal());
  }
  public final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptorForType() {
    return getDescriptor();
  }
  public static final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptor() {
    return io.temporal.api.enums.v1.TaskQueueProto.getDescriptor().getEnumTypes().get(3);
  }

  private static final BuildIdTaskReachability[] VALUES = values();

  public static BuildIdTaskReachability valueOf(
      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
    if (desc.getType() != getDescriptor()) {
      throw new java.lang.IllegalArgumentException(
        "EnumValueDescriptor is not for this type.");
    }
    if (desc.getIndex() == -1) {
      return UNRECOGNIZED;
    }
    return VALUES[desc.getIndex()];
  }

  private final int value;

  private BuildIdTaskReachability(int value) {
    this.value = value;
  }

  // @@protoc_insertion_point(enum_scope:temporal.api.enums.v1.BuildIdTaskReachability)
}