Class RetryOptions.Builder
- java.lang.Object
-
- io.temporal.common.RetryOptions.Builder
-
- Enclosing class:
- RetryOptions
public static final class RetryOptions.Builder extends java.lang.Object
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RetryOptions
build()
Build RetryOptions without performing validation as validation should be done after merging withMethodRetry
.RetryOptions.Builder
setBackoffCoefficient(double backoffCoefficient)
Coefficient used to calculate the next retry interval.RetryOptions.Builder
setDoNotRetry(java.lang.String... doNotRetry)
List of application failures types to not retry.RetryOptions.Builder
setInitialInterval(java.time.Duration initialInterval)
Interval of the first retry.RetryOptions.Builder
setMaximumAttempts(int maximumAttempts)
When exceeded the amount of attempts, stop.RetryOptions.Builder
setMaximumInterval(java.time.Duration maximumInterval)
Maximum interval between retries.RetryOptions
validateBuildWithDefaults()
Validates property values and builds RetryOptions with default values.
-
-
-
Method Detail
-
setInitialInterval
public RetryOptions.Builder setInitialInterval(java.time.Duration initialInterval)
Interval of the first retry. If coefficient is 1.0 then it is used for all retries. Required.
-
setBackoffCoefficient
public RetryOptions.Builder setBackoffCoefficient(double backoffCoefficient)
Coefficient used to calculate the next retry interval. The next retry interval is previous interval multiplied by this coefficient. Must be 1 or larger. Default is 2.0.
-
setMaximumAttempts
public RetryOptions.Builder setMaximumAttempts(int maximumAttempts)
When exceeded the amount of attempts, stop. Even if expiration time is not reached.
Default is unlimited.- Parameters:
maximumAttempts
- Maximum number of attempts. Default will be used if set to0
.
-
setMaximumInterval
public RetryOptions.Builder setMaximumInterval(java.time.Duration maximumInterval)
Maximum interval between retries. Exponential backoff leads to interval increase. This value is the cap of the increase.
Default is 100x of initial interval. Can't be less thansetInitialInterval(Duration)
- Parameters:
maximumInterval
- the maximum interval value. Default will be used if set tonull
.
-
setDoNotRetry
public RetryOptions.Builder setDoNotRetry(java.lang.String... doNotRetry)
List of application failures types to not retry.An application failure is represented as
ApplicationFailure
. The type of the failure is stored in theApplicationFailure.getType()
property. AnApplicationFailure
instance is created throughApplicationFailure.newFailure(String, String, Object...)
. An ApplicationFailure created throughApplicationFailure.newNonRetryableFailure(String, String, Object...)
will haveApplicationFailure.isNonRetryable()
property set to true which means that it is not retried even if the type of failure is not included into DoNotRetry list.If an activity or workflow throws any exception which is not
ApplicationFailure
then the exception is converted toApplicationFailure
with the fully qualified name of the exception as type value.Note that activity failures are wrapped into
ActivityFailure
exception. So if an activity failure is not handled the workflow retry policy is going to see ActivityFailure which is always retryable, not the original exception. The same way a child workflow failure is wrapped intoChildWorkflowFailure
.Error
andCanceledFailure
are never retried and are not even passed to this filter.
-
build
public RetryOptions build()
Build RetryOptions without performing validation as validation should be done after merging withMethodRetry
.
-
validateBuildWithDefaults
public RetryOptions validateBuildWithDefaults()
Validates property values and builds RetryOptions with default values.
-
-