com.uber.cadence.common

Annotation Type MethodRetry

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface MethodRetry

Specifies a retry policy for a workflow or activity method. This annotation applies only to activity or workflow interface methods. For workflows currently used only for child workflow retries. Not required. When not used either retries don't happen or they are configured through correspondent options. If RetryOptions are present on ActivityOptions or ChildWorkflowOptions the fields that are not default take precedence over parameters of this annotation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
double	backoffCoefficient Coefficient used to calculate the next retry interval.
java.lang.Class<? extends java.lang.Throwable>[]	doNotRetry List of exceptions to retry.
long	expirationSeconds Maximum time to retry.
long	initialIntervalSeconds Interval of the first retry.
int	maximumAttempts Maximum number of attempts.
long	maximumIntervalSeconds Maximum interval between retries.

Element Detail

initialIntervalSeconds

public abstract long initialIntervalSeconds

Interval of the first retry. If coefficient is 1.0 then it is used for all retries. If not specified here must be provided through RetryOptions.Builder.setInitialInterval(Duration).

Default:

0L

expirationSeconds

public abstract long expirationSeconds

Maximum time to retry. When exceeded the retries stop even if maximum retries is not reached yet. If not specified here must be provided through RetryOptions.Builder.setExpiration(Duration).

Default:

0L

backoffCoefficient

public abstract 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.

Default:

0.0

maximumAttempts

public abstract int maximumAttempts

Maximum number of attempts. When exceeded the retries stop even if not expired yet. Must be 1 or bigger. Default is unlimited.

Default:

0

maximumIntervalSeconds

public abstract long maximumIntervalSeconds

Maximum interval between retries. Exponential backoff leads to interval increase. This value is the cap of the increase. Default is 100x initialIntervalSeconds().

Default:

0L

doNotRetry

public abstract java.lang.Class<? extends java.lang.Throwable>[] doNotRetry

List of exceptions to retry. When matching an exact match is used. So adding RuntimeException.class to this list is going to include only RuntimeException itself, not all of its subclasses. The reason for such behaviour is to be able to support server side retries without knowledge of Java exception hierarchy. Error and CancellationException are never retried, so they are not allowed in this list.

Default:

{}