ZChildWorkflowOptions

zio.temporal.workflow.ZChildWorkflowOptions
See theZChildWorkflowOptions companion object
final case class ZChildWorkflowOptions

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def toJava: ChildWorkflowOptions

Convert to Java SDK's ChildWorkflowOptions

Convert to Java SDK's ChildWorkflowOptions

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def transformJavaOptions(f: Builder => Builder): ZChildWorkflowOptions

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

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

Attributes

Note

the options specified via this method take precedence over those specified via other methods.

def withCancellationType(value: ChildWorkflowCancellationType): ZChildWorkflowOptions

In case of a child workflow cancellation it fails with a zio.temporal.failure.CanceledFailure. The type defines at which point the exception is thrown.

In case of a child workflow cancellation it fails with a zio.temporal.failure.CanceledFailure. The type defines at which point the exception is thrown.

Attributes

def withContextPropagators(values: ContextPropagator*): ZChildWorkflowOptions

Specifies the list of context propagators to use during this workflow.

Specifies the list of context propagators to use during this workflow.

Attributes

def withContextPropagators(values: List[ContextPropagator]): ZChildWorkflowOptions

Specifies the list of context propagators to use during this workflow.

Specifies the list of context propagators to use during this workflow.

Attributes

def withMemo(values: (String, AnyRef)*): ZChildWorkflowOptions

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

Attributes

def withMemo(values: Map[String, AnyRef]): ZChildWorkflowOptions

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

Attributes

def withParentClosePolicy(value: ParentClosePolicy): ZChildWorkflowOptions

Specifies how this workflow reacts to the death of the parent workflow.

Specifies how this workflow reacts to the death of the parent workflow.

Attributes

RetryOptions that define how child workflow is retried in case of failure. Default is null which is no reties.

RetryOptions that define how child workflow is retried in case of failure. Default is null which is no reties.

Attributes

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.

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.

Attributes

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.

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.

Attributes

def withTaskQueue(value: String): ZChildWorkflowOptions

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.

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.

Attributes

def withVersioningIntent(value: VersioningIntent): ZChildWorkflowOptions

Specifies whether this child workflow should run on a worker with a compatible Build Id or not. See the variants of VersioningIntent.

Specifies whether this child workflow should run on a worker with a compatible Build Id or not. See the variants of VersioningIntent.

Attributes

The time after which child workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.
Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

The time after which child workflow execution (which includes run retries and continue as new) is automatically terminated by Temporal service with WORKFLOW_EXECUTION_TIMED_OUT status.
Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

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.

Attributes

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

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

Attributes

def withWorkflowIdReusePolicy(value: WorkflowIdReusePolicy): ZChildWorkflowOptions

AllowDuplicateFailedOnly is a default value. It means that workflow can start if previous run failed or was canceled or terminated.

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.

AllowDuplicateFailedOnly is a default value. It means that workflow can start if previous run failed or was canceled or terminated.

AllowDuplicate allows new run independently of the previous run closure status.

RejectDuplicate doesn't allow new run independently of the previous run closure status.

Attributes

The time after which child workflow run is automatically terminated by Temporal service with CHILD_WORKFLOW_EXECUTION_TIMED_OUT status.
Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

The time after which child workflow run is automatically terminated by Temporal service with CHILD_WORKFLOW_EXECUTION_TIMED_OUT status.
Parent workflow receives zio.temporal.failure.ChildWorkflowFailure exception with zio.temporal.failure.TimeoutFailure cause from the child's ZAsync if this happens.

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.

Attributes

Maximum execution time of a single workflow task. Default is 10 seconds. Maximum accepted value is 60 seconds.

Maximum execution time of a single workflow task. Default is 10 seconds. Maximum accepted value is 60 seconds.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product