Package io.temporal.workflow

Class ChildWorkflowOptions.Builder

java.lang.Object

io.temporal.workflow.ChildWorkflowOptions.Builder

Enclosing class:

ChildWorkflowOptions

public static final class ChildWorkflowOptions.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
ChildWorkflowOptions	build()
ChildWorkflowOptions.Builder	setCancellationType(ChildWorkflowCancellationType cancellationType)	In case of a child workflow cancellation it fails with a CanceledFailure.
ChildWorkflowOptions.Builder	setContextPropagators(java.util.List<ContextPropagator> contextPropagators)	Specifies the list of context propagators to use during this workflow.
ChildWorkflowOptions.Builder	setCronSchedule(CronSchedule c)
ChildWorkflowOptions.Builder	setCronSchedule(java.lang.String cronSchedule)
ChildWorkflowOptions.Builder	setMemo(java.util.Map<java.lang.String,java.lang.Object> memo)	Specifies additional non-indexed information in result of list workflow.
ChildWorkflowOptions.Builder	setMethodRetry(MethodRetry r)
ChildWorkflowOptions.Builder	setNamespace(java.lang.String namespace)	Specify namespace in which workflow should be started.
ChildWorkflowOptions.Builder	setParentClosePolicy(io.temporal.api.enums.v1.ParentClosePolicy parentClosePolicy)	Specifies how this workflow reacts to the death of the parent workflow.
ChildWorkflowOptions.Builder	setRetryOptions(RetryOptions retryOptions)	RetryOptions that define how child workflow is retried in case of failure.
ChildWorkflowOptions.Builder	setSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)	Specifies additional indexed information in result of list workflow.
ChildWorkflowOptions.Builder	setTaskQueue(java.lang.String taskQueue)	Task queue to use for workflow tasks.
ChildWorkflowOptions.Builder	setWorkflowExecutionTimeout(java.time.Duration workflowExecutionTimeout)	The maximum time that parent workflow is willing to wait for a child execution (which includes retries and continue as new calls).
ChildWorkflowOptions.Builder	setWorkflowId(java.lang.String workflowId)	Workflow id to use when starting.
ChildWorkflowOptions.Builder	setWorkflowIdReusePolicy(io.temporal.api.enums.v1.WorkflowIdReusePolicy workflowIdReusePolicy)	Specifies server behavior if a completed workflow with the same id exists.
ChildWorkflowOptions.Builder	setWorkflowRunTimeout(java.time.Duration workflowRunTimeout)	The time after which workflow run is automatically terminated by the Temporal service.
ChildWorkflowOptions.Builder	setWorkflowTaskTimeout(java.time.Duration workflowTaskTimeout)	Maximum execution time of a single workflow task.
ChildWorkflowOptions	validateAndBuildWithDefaults()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setNamespace

public ChildWorkflowOptions.Builder setNamespace(java.lang.String namespace)

Specify namespace in which workflow should be started.

TODO: Resolve conflict with WorkflowClient namespace.

setWorkflowId

public ChildWorkflowOptions.Builder setWorkflowId(java.lang.String workflowId)

Workflow id to use when starting. If not specified a UUID is generated. Note that it is dangerous as in case of client side retries no deduplication will happen based on the generated id. So prefer assigning business meaningful ids if possible.

setWorkflowIdReusePolicy

public ChildWorkflowOptions.Builder setWorkflowIdReusePolicy(io.temporal.api.enums.v1.WorkflowIdReusePolicy workflowIdReusePolicy)

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.

setWorkflowRunTimeout

public ChildWorkflowOptions.Builder setWorkflowRunTimeout(java.time.Duration workflowRunTimeout)

The time after which workflow run is automatically terminated by the Temporal service. Do not rely on the run timeout for business level timeouts. It is preferred to use in workflow timers for this purpose.

setWorkflowExecutionTimeout

public ChildWorkflowOptions.Builder setWorkflowExecutionTimeout(java.time.Duration workflowExecutionTimeout)

The maximum time that parent workflow is willing to wait for a child execution (which includes retries and continue as new calls). If exceeded the child is automatically terminated by the Temporal service.

setWorkflowTaskTimeout

public ChildWorkflowOptions.Builder setWorkflowTaskTimeout(java.time.Duration workflowTaskTimeout)

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

setTaskQueue

public ChildWorkflowOptions.Builder setTaskQueue(java.lang.String taskQueue)

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

setRetryOptions

public ChildWorkflowOptions.Builder setRetryOptions(RetryOptions retryOptions)

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

setCronSchedule

public ChildWorkflowOptions.Builder setCronSchedule(java.lang.String cronSchedule)

setParentClosePolicy

public ChildWorkflowOptions.Builder setParentClosePolicy(io.temporal.api.enums.v1.ParentClosePolicy parentClosePolicy)

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

setMemo

public ChildWorkflowOptions.Builder setMemo(java.util.Map<java.lang.String,java.lang.Object> memo)

Specifies additional non-indexed information in result of list workflow.

setSearchAttributes

public ChildWorkflowOptions.Builder setSearchAttributes(java.util.Map<java.lang.String,java.lang.Object> searchAttributes)

Specifies additional indexed information in result of list workflow.

setContextPropagators

public ChildWorkflowOptions.Builder setContextPropagators(java.util.List<ContextPropagator> contextPropagators)

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

setCancellationType

public ChildWorkflowOptions.Builder setCancellationType(ChildWorkflowCancellationType cancellationType)

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

setMethodRetry

public ChildWorkflowOptions.Builder setMethodRetry(MethodRetry r)

setCronSchedule

public ChildWorkflowOptions.Builder setCronSchedule(CronSchedule c)

build

public ChildWorkflowOptions build()

validateAndBuildWithDefaults

public ChildWorkflowOptions validateAndBuildWithDefaults()