Interface WorkflowInstanceCreateOptions<PARAMS>

interface WorkflowInstanceCreateOptions<PARAMS = unknown> {
    id?: string;
    locationHint?: WorkflowInstanceLocationHint;
    params?: PARAMS;
    retention?: {
        errorRetention?: WorkflowSleepDuration;
        successRetention?: WorkflowSleepDuration;
    };
}

Type Parameters

PARAMS = unknown

Index

Properties

id? locationHint? params? retention?

Properties

`Optional`id

id?: string

An id for your Workflow instance. Must be unique within the Workflow.

`Optional`locationHint

locationHint?: WorkflowInstanceLocationHint

A best-effort geographic placement preference for the Workflow instance. See WorkflowInstanceLocationHint for supported regions.

`Optional`params

params?: PARAMS

The event payload the Workflow instance is triggered with

`Optional`retention

retention?: {
errorRetention?: WorkflowSleepDuration;
successRetention?: WorkflowSleepDuration;
}

The retention policy for Workflow instance. Defaults to the maximum retention period available for the owner's account.