io.temporal.api.enums.v1.ScheduleOverlapPolicy 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/schedule.proto

package io.temporal.api.enums.v1;

/**
 *  * ScheduleOverlapPolicy controls what happens when a workflow would be started
 * by a schedule, and is already running.
 * 
 *
 * Protobuf enum {@code temporal.api.enums.v1.ScheduleOverlapPolicy}
 */
@javax.annotation.Generated(value="protoc", comments="annotations:ScheduleOverlapPolicy.java.pb.meta")
public enum ScheduleOverlapPolicy
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   * SCHEDULE_OVERLAP_POLICY_UNSPECIFIED = 0;
   */
  SCHEDULE_OVERLAP_POLICY_UNSPECIFIED(0),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_SKIP (default) means don't start anything. When the
   * workflow completes, the next scheduled event after that time will be considered.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_SKIP = 1;
   */
  SCHEDULE_OVERLAP_POLICY_SKIP(1),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_BUFFER_ONE means start the workflow again soon as the
   * current one completes, but only buffer one start in this way. If another start is
   * supposed to happen when the workflow is running, and one is already buffered, then
   * only the first one will be started after the running workflow finishes.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_BUFFER_ONE = 2;
   */
  SCHEDULE_OVERLAP_POLICY_BUFFER_ONE(2),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_BUFFER_ALL means buffer up any number of starts to all
   * happen sequentially, immediately after the running workflow completes.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_BUFFER_ALL = 3;
   */
  SCHEDULE_OVERLAP_POLICY_BUFFER_ALL(3),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER means that if there is another workflow
   * running, cancel it, and start the new one after the old one completes cancellation.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER = 4;
   */
  SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER(4),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER means that if there is another workflow
   * running, terminate it and start the new one immediately.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER = 5;
   */
  SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER(5),
  /**
   *    * SCHEDULE_OVERLAP_POLICY_ALLOW_ALL means start any number of concurrent workflows.
   * Note that with this policy, last completion result and last failure will not be
   * available since workflows are not sequential.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_ALLOW_ALL = 6;
   */
  SCHEDULE_OVERLAP_POLICY_ALLOW_ALL(6),
  UNRECOGNIZED(-1),
  ;

  /**
   * SCHEDULE_OVERLAP_POLICY_UNSPECIFIED = 0;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_UNSPECIFIED_VALUE = 0;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_SKIP (default) means don't start anything. When the
   * workflow completes, the next scheduled event after that time will be considered.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_SKIP = 1;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_SKIP_VALUE = 1;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_BUFFER_ONE means start the workflow again soon as the
   * current one completes, but only buffer one start in this way. If another start is
   * supposed to happen when the workflow is running, and one is already buffered, then
   * only the first one will be started after the running workflow finishes.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_BUFFER_ONE = 2;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_BUFFER_ONE_VALUE = 2;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_BUFFER_ALL means buffer up any number of starts to all
   * happen sequentially, immediately after the running workflow completes.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_BUFFER_ALL = 3;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_BUFFER_ALL_VALUE = 3;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER means that if there is another workflow
   * running, cancel it, and start the new one after the old one completes cancellation.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER = 4;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER_VALUE = 4;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER means that if there is another workflow
   * running, terminate it and start the new one immediately.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER = 5;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER_VALUE = 5;
  /**
   *    * SCHEDULE_OVERLAP_POLICY_ALLOW_ALL means start any number of concurrent workflows.
   * Note that with this policy, last completion result and last failure will not be
   * available since workflows are not sequential.
   * 
   *
   * SCHEDULE_OVERLAP_POLICY_ALLOW_ALL = 6;
   */
  public static final int SCHEDULE_OVERLAP_POLICY_ALLOW_ALL_VALUE = 6;


  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 ScheduleOverlapPolicy 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 ScheduleOverlapPolicy forNumber(int value) {
    switch (value) {
      case 0: return SCHEDULE_OVERLAP_POLICY_UNSPECIFIED;
      case 1: return SCHEDULE_OVERLAP_POLICY_SKIP;
      case 2: return SCHEDULE_OVERLAP_POLICY_BUFFER_ONE;
      case 3: return SCHEDULE_OVERLAP_POLICY_BUFFER_ALL;
      case 4: return SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER;
      case 5: return SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER;
      case 6: return SCHEDULE_OVERLAP_POLICY_ALLOW_ALL;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      ScheduleOverlapPolicy> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public ScheduleOverlapPolicy findValueByNumber(int number) {
            return ScheduleOverlapPolicy.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.ScheduleProto.getDescriptor().getEnumTypes().get(0);
  }

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

  public static ScheduleOverlapPolicy 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 ScheduleOverlapPolicy(int value) {
    this.value = value;
  }

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