Package io.temporal.api.enums.v1

Enum WorkflowIdConflictPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<WorkflowIdConflictPolicy>
    @Generated(value="protoc",
           comments="annotations:WorkflowIdConflictPolicy.java.pb.meta")
public enum WorkflowIdConflictPolicy
extends java.lang.Enum<WorkflowIdConflictPolicy>
implements com.google.protobuf.ProtocolMessageEnum
     Defines what to do when trying to start a workflow with the same workflow id as a *running* workflow.
 Note that it is *never* valid to have two actively running instances of the same workflow id.

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

    • Enum Constant Detail

      • WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED

        public static final WorkflowIdConflictPolicy WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED
        WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED = 0;

      • WORKFLOW_ID_CONFLICT_POLICY_FAIL

        public static final WorkflowIdConflictPolicy WORKFLOW_ID_CONFLICT_POLICY_FAIL
         Don't start a new workflow; instead return `WorkflowExecutionAlreadyStartedFailure`.
        WORKFLOW_ID_CONFLICT_POLICY_FAIL = 1;

      • WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING

        public static final WorkflowIdConflictPolicy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING
         Don't start a new workflow; instead return a workflow handle for the running workflow.
        WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING = 2;

      • WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING

        public static final WorkflowIdConflictPolicy WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING
         Terminate the running workflow before starting a new one.
        WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING = 3;

    • Field Detail

      • WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED_VALUE

        public static final int WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED_VALUE
        WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • WORKFLOW_ID_CONFLICT_POLICY_FAIL_VALUE

        public static final int WORKFLOW_ID_CONFLICT_POLICY_FAIL_VALUE
         Don't start a new workflow; instead return `WorkflowExecutionAlreadyStartedFailure`.
        WORKFLOW_ID_CONFLICT_POLICY_FAIL = 1;
        See Also:
        Constant Field Values

      • WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING_VALUE

        public static final int WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING_VALUE
         Don't start a new workflow; instead return a workflow handle for the running workflow.
        WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING = 2;
        See Also:
        Constant Field Values

      • WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING_VALUE

        public static final int WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING_VALUE
         Terminate the running workflow before starting a new one.
        WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING = 3;
        See Also:
        Constant Field Values

    • Method Detail

      • values

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

      • valueOf

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