Enum Class WorkflowIdReusePolicy

java.lang.Object
java.lang.Enum<WorkflowIdReusePolicy>
io.temporal.api.enums.v1.WorkflowIdReusePolicy
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<WorkflowIdReusePolicy>, Constable
@Generated(value="protoc", comments="annotations:WorkflowIdReusePolicy.java.pb.meta") public enum WorkflowIdReusePolicy extends Enum<WorkflowIdReusePolicy> implements com.google.protobuf.ProtocolMessageEnum
 Defines whether to allow re-using a workflow id from a previously *closed* workflow.
 If the request is denied, the server returns a `WorkflowExecutionAlreadyStartedFailure` error.

 See `WorkflowIdConflictPolicy` for handling workflow id duplication with a *running* workflow.
Protobuf enum temporal.api.enums.v1.WorkflowIdReusePolicy

  • Enum Constant Details

    • WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED

      public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED
      WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED = 0;

    • WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE

      public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE
       Allow starting a workflow execution using the same workflow id.
      WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE = 1;

    • WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY

      public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY
       Allow starting a workflow execution using the same workflow id, only when the last
 execution's final state is one of [terminated, cancelled, timed out, failed].
      WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY = 2;

    • WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE

      public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE
       Do not permit re-use of the workflow id for this workflow. Future start workflow requests
 could potentially change the policy, allowing re-use of the workflow id.
      WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE = 3;

    • WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING

      @Deprecated public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
      Deprecated.
       Terminate the current Workflow if one is already running; otherwise allow reusing the
 Workflow ID. When using this option, `WorkflowIdConflictPolicy` must be left unspecified.

 Deprecated. Instead, set `WorkflowIdReusePolicy` to `ALLOW_DUPLICATE` and
 `WorkflowIdConflictPolicy` to `TERMINATE_EXISTING`. Note that `WorkflowIdConflictPolicy`
 requires Temporal Server v1.24.0 or later.
      WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING = 4 [deprecated = true];

    • UNRECOGNIZED

      public static final WorkflowIdReusePolicy UNRECOGNIZED

  • Field Details

    • WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED_VALUE

      public static final int WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED_VALUE
      WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED = 0;
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_VALUE

      public static final int WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_VALUE
       Allow starting a workflow execution using the same workflow id.
      WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE = 1;
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY_VALUE

      public static final int WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY_VALUE
       Allow starting a workflow execution using the same workflow id, only when the last
 execution's final state is one of [terminated, cancelled, timed out, failed].
      WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY = 2;
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE_VALUE

      public static final int WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE_VALUE
       Do not permit re-use of the workflow id for this workflow. Future start workflow requests
 could potentially change the policy, allowing re-use of the workflow id.
      WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE = 3;
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING_VALUE

      @Deprecated public static final int WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING_VALUE
      Deprecated.
       Terminate the current Workflow if one is already running; otherwise allow reusing the
 Workflow ID. When using this option, `WorkflowIdConflictPolicy` must be left unspecified.

 Deprecated. Instead, set `WorkflowIdReusePolicy` to `ALLOW_DUPLICATE` and
 `WorkflowIdConflictPolicy` to `TERMINATE_EXISTING`. Note that `WorkflowIdConflictPolicy`
 requires Temporal Server v1.24.0 or later.
      WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING = 4 [deprecated = true];
      See Also:

  • Method Details

    • values

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