ZWorkflowOptions

Convert to Java SDK's WorkflowOptions

Returns a string representation of the object.

The default representation is platform dependent.

Allows to specify options directly on the java SDK's WorkflowOptions. Use it in case an appropriate withXXX method is missing

This list of context propagators overrides the list specified on ZWorkflowClientOptions.contextPropagators.
This method is uncommon, the majority of users should just set ZWorkflowClientOptions.contextPropagators

This list of context propagators overrides the list specified on ZWorkflowClientOptions.contextPropagators.
This method is uncommon, the majority of users should just set ZWorkflowClientOptions.contextPropagators

If ZWorkflowClient is used to create a zio.temporal.worker.ZWorkerFactory that is

• started
• has a non-paused worker on the right task queue
• has available workflow task executor slots

and such a ZWorkflowClient is used to start a workflow, then the first workflow task could be dispatched on this local worker with the response to the start call if Server supports it. This option can be used to disable this mechanism.

Specifies additional non-indexed information in result of list workflow. The type of value can be any object that are serializable by io.temporal.common.converter.DataConverter

Specifies additional non-indexed information in result of list workflow. The type of value can be any object that are serializable by io.temporal.common.converter.DataConverter

Specifies retry optiosn for this workflow

Specifies Search Attributes that will be attached to the Workflow. Search Attributes are additional indexed information attributed to workflow and used for search and visibility.

The search attributes can be used in query of List/Scan/Count workflow APIs. The key and its value type must be registered on Temporal server side.

Specifies Search Attributes that will be attached to the Workflow. Search Attributes are additional indexed information attributed to workflow and used for search and visibility.

The search attributes can be used in query of List/Scan/Count workflow APIs. The key and its value type must be registered on Temporal server side.

Task queue to use for workflow tasks. It should match a task queue specified when creating a zio.temporal.worker.ZWorker that hosts the workflow code.

The time after which workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.

When a workflow reaches Workflow Execution Timeout, it can't make any progress after that. Do not rely on this timeout in workflow implementation or business logic. This timeout is not designed to be handled in workflow code to perform any logic in case of timeout. Consider using workflow timers instead.

If you catch yourself setting this timeout to very small values, you're likely using it wrong.

Example: If Workflow Execution Timeout is 30 seconds and the network was unavailable for 1 minute, workflows that were scheduled before the network blip will never have a chance to make progress or react, and will be terminated.
A timer that is scheduled in the workflow code using ZWorkflow.newTimer will handle this situation gracefully. A workflow with such a timer will start after the network blip. If it started before the network blip and the timer fires during the network blip, it will get delivered after connectivity is restored and the workflow will be able to resume.

Workflow id to use when starting. Prefer assigning business meaningful ids if possible.

Specifies server behavior if a completed workflow with the same id exists. Note that under no conditions Temporal allows two workflows with the same namespace and workflow id run simultaneously.

Default value if not set: AllowDuplicate

• AllowDuplicate allows a new run regardless of the previous run's final status. The previous run still must be closed or the new run will be rejected.
• AllowDuplicateFailedOnly allows a new run if the previous run failed, was canceled, or terminated.
• RejectDuplicate never allows a new run, regardless of the previous run's final status.
• TerminateIfRunning is the same as AllowDuplicate, but if there exists a not-closed run in progress, it will be terminated.

The time after which a workflow run is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.

When a workflow reaches Workflow Run Timeout, it can't make any progress after that. Do not rely on this timeout in workflow implementation or business logic. This timeout is not designed to be handled in workflow code to perform any logic in case of timeout. Consider using workflow timers instead.

If you catch yourself setting this timeout to very small values, you're likely using it wrong.

Example: If Workflow Run Timeout is 30 seconds and the network was unavailable for 1 minute, workflows that were scheduled before the network blip will never have a chance to make progress or react, and will be terminated.
A timer that is scheduled in the workflow code using ZWorkflow.newTimer will handle this situation gracefully. A workflow with such a timer will start after the network blip. If it started before the network blip and the timer fires during the network blip, it will get delivered after connectivity is restored and the workflow will be able to resume.

Maximum execution time of a single Workflow Task. In the majority of cases there is no need to change this timeout. Note that this timeout is not related to the overall Workflow duration in any way. It defines for how long the Workflow can get blocked in the case of a Workflow Worker crash.

Default is 10 seconds. Maximum value allowed by the Temporal Server is 1 minute.