nestjs-temporal-core
    Preparing search index...

    Variable WorkflowIdReusePolicyConst

    WorkflowIdReusePolicy: {
        ALLOW_DUPLICATE: "ALLOW_DUPLICATE";
        ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY";
        REJECT_DUPLICATE: "REJECT_DUPLICATE";
        TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING";
        WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: "ALLOW_DUPLICATE";
        WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY";
        WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: "REJECT_DUPLICATE";
        WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING";
        WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined;
    }

    Defines what happens when trying to start a Workflow with the same ID as a Closed Workflow.

    See WorkflowOptions.workflowIdConflictPolicy for what happens when trying to start a Workflow with the same ID as a Running Workflow.

    Concept: Workflow Id Reuse Policy

    Note: It is not possible to have two actively running Workflows with the same ID.

    Type Declaration

    • ReadonlyALLOW_DUPLICATE: "ALLOW_DUPLICATE"

      The Workflow can be started if the previous Workflow is in a Closed state.
    • ReadonlyALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY"

      The Workflow can be started if the previous Workflow is in a Closed state that is not Completed.

    • ReadonlyREJECT_DUPLICATE: "REJECT_DUPLICATE"

      The Workflow cannot be started.

    • ReadonlyTERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING"

      Terminate the current Workflow if one is already running; otherwise allow reusing the Workflow ID.

      Use WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE instead, and set WorkflowOptions.workflowIdConflictPolicy to WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING. When using this option, WorkflowOptions.workflowIdConflictPolicy must be left unspecified.

    • ReadonlyWORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: "ALLOW_DUPLICATE"

      Use ALLOW_DUPLICATE instead.

    • ReadonlyWORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY"

      Use ALLOW_DUPLICATE_FAILED_ONLY instead.

    • ReadonlyWORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: "REJECT_DUPLICATE"

      Use REJECT_DUPLICATE instead.

    • ReadonlyWORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING"

      Use TERMINATE_IF_RUNNING instead.

    • ReadonlyWORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined

      No need to use this. If a WorkflowIdReusePolicy is set to this, or is not set at all, the default value will be used.

      Either leave property undefined, or use ALLOW_DUPLICATE instead.

    Settings

    Member Visibility