Fields

• namespace :: !Namespace

  Default namespace for all workflows started by this client.

• interceptors :: !ClientInterceptors

  Interceptors to be used by the client.

• payloadProcessor :: !PayloadProcessor

  The payload processor to be used by the client.

  This can be used to apply encryption and compression to payloads.

Fields

• taskQueue :: TaskQueue

  A Task Queue is a lightweight, dynamically allocated queue that one or more Worker Entities poll for Tasks.

  Task Queues are very lightweight components. Task Queues do not require explicit registration but instead are created on demand when a Workflow Execution spawns or when a Worker Process subscribes to it. When a Task Queue is created, both a Workflow Task Queue and an Activity Task Queue are created under the same name. There is no limit to the number of Task Queues a Temporal Application can use or a Temporal Cluster can maintain.

• followRuns :: Bool
   
• workflowIdReusePolicy :: Maybe WorkflowIdReusePolicy

  A Workflow Id Reuse Policy determines whether a Workflow Execution is allowed to spawn with a particular Workflow Id, if that Workflow Id has been used with a previous, and now Closed, Workflow Execution.

  It is not possible for a new Workflow Execution to spawn with the same Workflow Id as another Open Workflow Execution, regardless of the Workflow Id Reuse Policy. In some cases, an attempt to spawn a Workflow Execution with a Workflow Id that is the same as the Id of a currently Open Workflow Execution results in a Workflow execution already started error.

• retryPolicy :: Maybe RetryPolicy

  A Retry Policy can work in cooperation with the timeouts to provide fine controls to optimize the execution experience.

  Use a Retry Policy to retry a Workflow Execution in the event of a failure.

  Workflow Executions do not retry by default, and Retry Policies should be used with Workflow Executions only in certain situations.

  This should not be confused with Activity retry policies, which are used to retry Activities and specified at those callsites.

• cronSchedule :: Maybe Text

  A Temporal Cron Job is the series of Workflow Executions that occur when a Cron Schedule is provided in the call to spawn a Workflow Execution.

  A Cron Schedule is provided as an option when the call to spawn a Workflow Execution is made.

  You can set each Workflow to repeat on a schedule with the cronSchedule option:

  Temporal.Client.start scheduledWorkflow
    (Temporal.Client.startWorkflowOptions "my-workflow" "my-task-queue") { cronSchedule = Just "* * * * *" } -- start every minute
  

  Note that Temporal offers more advanced scheduling support via Schedule, so it is generally recommended to use that instead of Cron Schedules.

• memo :: !(Map Text Payload)

  A Memo is a non-indexed set of Workflow Execution metadata that developers supply at start time or in Workflow code and that is returned when you describe or list Workflow Executions.

  The primary purpose of using a Memo is to enhance the organization and management of Workflow Executions. Add your own metadata, such as notes or descriptions, to a Workflow Execution, which lets you annotate and categorize Workflow Executions based on developer-defined criteria. This feature is particularly useful when dealing with numerous Workflow Executions because it facilitates the addition of context, reminders, or any other relevant information that aids in understanding or tracking the Workflow Execution.

• searchAttributes :: !(Map SearchAttributeKey SearchAttributeType)

  Search attributes are indexed by the Temporal server and can be used in queries on the dashboard or by the Temporal CLI to find Workflows. These values are not encrypted and can be seen by anyone with access to the Temporal namespace.

• headers :: !(Map Text Payload)

  Custom headers to be added to the Workflow Execution. These are generally more useful for interceptors to add metadata to the Workflow rather than for application code.

• timeouts :: TimeoutOptions

  Each Workflow timeout controls the maximum duration of a different aspect of a Workflow Execution.

• requestEagerExecution :: Bool

  Eager activity execution is an optimization on some servers that sends activities back to the same worker as the calling workflow if they can run there.

• workflowStartDelay :: Maybe Duration
   

Fields

• executionTimeout :: Maybe Duration

  A Workflow Execution Timeout is the maximum time that a Workflow Execution can be executing (have an Open status) including retries and any usage of Continue As New.

  The default value is ∞ (infinite). If this timeout is reached, the Workflow Execution changes to a Timed Out status. This timeout is different from the Workflow Run Timeout. This timeout is most commonly used for stopping the execution of a Temporal Cron Job after a certain amount of time has passed.

• runTimeout :: Maybe Duration

  A Workflow Run Timeout is the maximum amount of time that a single Workflow Run is restricted to.

  The default is set to the same value as the Workflow Execution Timeout. This timeout is most commonly used to limit the execution time of a single Temporal Cron Job Execution.

  If the Workflow Run Timeout is reached, the Workflow Execution is Terminated.

• taskTimeout :: Maybe Duration

  A Workflow Task Timeout is the maximum amount of time allowed for a Worker to execute a Workflow Task after the Worker has pulled that Workflow Task from the Task Queue.

  The default value is 10 seconds. This timeout is primarily available to recognize whether a Worker has gone down so that the Workflow Execution can be recovered on a different Worker. The main reason for increasing the default value would be to accommodate a Workflow Execution that has a very long Workflow Execution History that could take longer than 10 seconds for the Worker to load.

Fields

• terminationReason :: Text
   
• terminationDetails :: [Payload]
   
• firstExecutionRunId :: Maybe RunId

  If set, this call will error if the (most recent | specified workflow run id in the WorkflowHandle) is not part of the same execution chain as this id.

Fields

• queryRejectCondition :: QueryRejectCondition
   
• queryHeaders :: Map Text Payload
   

Fields

• status :: WorkflowExecutionStatus
   

Fields

• requestId :: Maybe Text

  Used to de-dupe sent signals

• skipGenerateWorkflowTask :: Bool

  Indicates that a new workflow task should not be generated when this signal is received.

  Defaults to False.

  Generally this is not needed.

• headers :: Map Text Payload
   

Fields

• signalName :: Text
   
• signalCodec :: codec