Enum Class ScheduleOverlapPolicy

java.lang.Object
java.lang.Enum<ScheduleOverlapPolicy>
io.temporal.api.enums.v1.ScheduleOverlapPolicy
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ScheduleOverlapPolicy>, Constable
@Generated(value="protoc", comments="annotations:ScheduleOverlapPolicy.java.pb.meta") public enum ScheduleOverlapPolicy extends Enum<ScheduleOverlapPolicy> implements com.google.protobuf.ProtocolMessageEnum
 ScheduleOverlapPolicy controls what happens when a workflow would be started
 by a schedule, and is already running.
Protobuf enum temporal.api.enums.v1.ScheduleOverlapPolicy

  • Enum Constant Details

    • SCHEDULE_OVERLAP_POLICY_UNSPECIFIED

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_UNSPECIFIED
      SCHEDULE_OVERLAP_POLICY_UNSPECIFIED = 0;

    • SCHEDULE_OVERLAP_POLICY_SKIP

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_SKIP
       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_BUFFER_ONE

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_BUFFER_ONE
       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_ALL

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_BUFFER_ALL
       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_CANCEL_OTHER

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER
       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_TERMINATE_OTHER

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER
       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_ALLOW_ALL

      public static final ScheduleOverlapPolicy SCHEDULE_OVERLAP_POLICY_ALLOW_ALL
       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;

    • UNRECOGNIZED

      public static final ScheduleOverlapPolicy UNRECOGNIZED

  • Field Details

    • SCHEDULE_OVERLAP_POLICY_UNSPECIFIED_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_UNSPECIFIED_VALUE
      SCHEDULE_OVERLAP_POLICY_UNSPECIFIED = 0;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_SKIP_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_SKIP_VALUE
       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;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_BUFFER_ONE_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_BUFFER_ONE_VALUE
       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;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_BUFFER_ALL_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_BUFFER_ALL_VALUE
       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;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_CANCEL_OTHER_VALUE
       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;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_TERMINATE_OTHER_VALUE
       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;
      See Also:

    • SCHEDULE_OVERLAP_POLICY_ALLOW_ALL_VALUE

      public static final int SCHEDULE_OVERLAP_POLICY_ALLOW_ALL_VALUE
       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;
      See Also:

  • Method Details

    • values

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