io.temporal.activity

Class ActivityOptions.Builder

java.lang.Object

io.temporal.activity.ActivityOptions.Builder

Enclosing class:

ActivityOptions

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

Method Summary

Modifier and Type	Method and Description
ActivityOptions	build()
ActivityOptions.Builder	mergeMethodRetry(MethodRetry r) Properties that are set on this builder take precedence over ones found in the annotation.
ActivityOptions.Builder	setCancellationType(ActivityCancellationType cancellationType) In case of an activity cancellation it fails with a CanceledFailure.
ActivityOptions.Builder	setContextPropagators(java.util.List<ContextPropagator> contextPropagators) ContextPropagators help propagate the context from the workflow to the activities
ActivityOptions.Builder	setHeartbeatTimeout(java.time.Duration heartbeatTimeoutSeconds) Heartbeat interval.
ActivityOptions.Builder	setRetryOptions(RetryOptions retryOptions) RetryOptions that define how activity is retried in case of failure.
ActivityOptions.Builder	setScheduleToCloseTimeout(java.time.Duration scheduleToCloseTimeout) Overall timeout workflow is willing to wait for activity to complete.
ActivityOptions.Builder	setScheduleToStartTimeout(java.time.Duration scheduleToStartTimeout) Time activity can stay in task queue before it is picked up by a worker.
ActivityOptions.Builder	setStartToCloseTimeout(java.time.Duration startToCloseTimeout) Maximum activity execution time after it was sent to a worker.
ActivityOptions.Builder	setTaskQueue(java.lang.String taskQueue) Task queue to use when dispatching activity task to a worker.
ActivityOptions	validateAndBuildWithDefaults()

Methods inherited from class java.lang.Object

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

Method Detail

setScheduleToCloseTimeout

public ActivityOptions.Builder setScheduleToCloseTimeout(java.time.Duration scheduleToCloseTimeout)

Overall timeout workflow is willing to wait for activity to complete. It includes time in a task queue (use setScheduleToStartTimeout(Duration) to limit it) plus activity execution time (use setStartToCloseTimeout(Duration) to limit it). Either this option or both schedule to start and start to close are required.

setScheduleToStartTimeout

public ActivityOptions.Builder setScheduleToStartTimeout(java.time.Duration scheduleToStartTimeout)

Time activity can stay in task queue before it is picked up by a worker. If schedule to close is not provided then both this and start to close are required.

setStartToCloseTimeout

public ActivityOptions.Builder setStartToCloseTimeout(java.time.Duration startToCloseTimeout)

Maximum activity execution time after it was sent to a worker. If schedule to close is not provided then both this and schedule to start are required.

setHeartbeatTimeout

public ActivityOptions.Builder setHeartbeatTimeout(java.time.Duration heartbeatTimeoutSeconds)

Heartbeat interval. Activity must heartbeat before this interval passes after a last heartbeat or activity start.

setTaskQueue

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

Task queue to use when dispatching activity task to a worker. By default it is the same task list name the workflow was started with.

setRetryOptions

public ActivityOptions.Builder setRetryOptions(RetryOptions retryOptions)

RetryOptions that define how activity is retried in case of failure. If this is not set, then the server-defined default activity retry policy will be used. To ensure zero retries, set maximum attempts to 1.

setContextPropagators

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

ContextPropagators help propagate the context from the workflow to the activities

setCancellationType

public ActivityOptions.Builder setCancellationType(ActivityCancellationType cancellationType)

In case of an activity cancellation it fails with a CanceledFailure. If this flag is set to false then the exception is thrown not immediately but only after an activity completes its cleanup. If true a CanceledFailure is thrown immediately and an activity cancellation is going to happen in the background.

mergeMethodRetry

public ActivityOptions.Builder mergeMethodRetry(MethodRetry r)

Properties that are set on this builder take precedence over ones found in the annotation.

build

public ActivityOptions build()

validateAndBuildWithDefaults

public ActivityOptions validateAndBuildWithDefaults()