Package io.temporal.api.enums.v1

Enum WorkflowIdReusePolicy

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

      • 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

        public static final WorkflowIdReusePolicy WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING
         This option belongs in WorkflowIdConflictPolicy but is here for backwards compatibility.
 If specified, it acts like ALLOW_DUPLICATE, but also the WorkflowId*Conflict*Policy on
 the request is treated as WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING.
 If no running workflow, then the behavior is the same as ALLOW_DUPLICATE.
        WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING = 4;

    • Field Detail

      • WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED_VALUE

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

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

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

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

      • WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING_VALUE

        public static final int WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING_VALUE
         This option belongs in WorkflowIdConflictPolicy but is here for backwards compatibility.
 If specified, it acts like ALLOW_DUPLICATE, but also the WorkflowId*Conflict*Policy on
 the request is treated as WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING.
 If no running workflow, then the behavior is the same as ALLOW_DUPLICATE.
        WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING = 4;
        See Also:
        Constant Field Values

    • Method Detail

      • values

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

      • valueOf

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