Package com.google.adk.workflow

Class RetryConfig

java.lang.Object

com.google.adk.workflow.RetryConfig

@Experimental
public abstract class RetryConfig
extends Object

How a node is retried when it fails. The builder initializes each property to its DEFAULT_ constant, except exceptions() and exceptionClasses(), which start unset.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RetryConfig.Builder	Builder for RetryConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_BACKOFF_FACTOR	The default for backoffFactor().
static final Duration	DEFAULT_INITIAL_DELAY	The default for initialDelay().
static final double	DEFAULT_JITTER	The default for jitter().
static final int	DEFAULT_MAX_ATTEMPTS	The default for maxAttempts().
static final Duration	DEFAULT_MAX_DELAY	The default for maxDelay().

Constructor Summary

Constructors

Constructor	Description
RetryConfig()

Method Summary

Modifier and Type	Method	Description
abstract double	backoffFactor()	Returns the multiplier applied to the delay after each attempt.
static RetryConfig.Builder	builder()
abstract Optional<com.google.common.collect.ImmutableList<Class<? extends Exception>>>	exceptionClasses()	Returns the types of the failures to retry on, each also matching its subclasses.
abstract Optional<com.google.common.collect.ImmutableList<String>>	exceptions()	Returns the simple type names of the failures to retry on, matched exactly with no subclass match.
abstract Duration	initialDelay()	Returns the delay before the first retry.
abstract double	jitter()	Returns the randomness factor, not a duration: the delay is spread over delay * (1 +/- jitter).
abstract int	maxAttempts()	Returns the maximum number of attempts, including the first, so 0 or 1 means no retry.
abstract Duration	maxDelay()	Returns the ceiling on any single delay.
abstract RetryConfig.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_ATTEMPTS

public static final int DEFAULT_MAX_ATTEMPTS

The default for maxAttempts().

See Also:

• Constant Field Values

DEFAULT_INITIAL_DELAY

public static final Duration DEFAULT_INITIAL_DELAY

The default for initialDelay().

DEFAULT_MAX_DELAY

public static final Duration DEFAULT_MAX_DELAY

The default for maxDelay().

DEFAULT_BACKOFF_FACTOR

public static final double DEFAULT_BACKOFF_FACTOR

The default for backoffFactor().

See Also:

• Constant Field Values

DEFAULT_JITTER

public static final double DEFAULT_JITTER

The default for jitter().

See Also:

• Constant Field Values

Constructor Details

RetryConfig

public RetryConfig()

Method Details

maxAttempts

public abstract int maxAttempts()

Returns the maximum number of attempts, including the first, so 0 or 1 means no retry.

initialDelay

public abstract Duration initialDelay()

Returns the delay before the first retry.

maxDelay

public abstract Duration maxDelay()

Returns the ceiling on any single delay.

backoffFactor

public abstract double backoffFactor()

Returns the multiplier applied to the delay after each attempt.

jitter

public abstract double jitter()

Returns the randomness factor, not a duration: the delay is spread over delay * (1 +/- jitter). Zero removes randomness.

exceptions

public abstract Optional<com.google.common.collect.ImmutableList<String>> exceptions()

Returns the simple type names of the failures to retry on, matched exactly with no subclass match. A failure is retried when it matches this list or exceptionClasses(), and any failure is retried when both are unset. A WorkflowConfigurationException is never retried, even when listed, because a retry fails the same way.

exceptionClasses

public abstract Optional<com.google.common.collect.ImmutableList<Class<? extends Exception>>> exceptionClasses()

Returns the types of the failures to retry on, each also matching its subclasses. A failure is retried when it matches this list or exceptions(), and any failure is retried when both are unset. A WorkflowConfigurationException is never retried, even when its class is listed.

builder

public static RetryConfig.Builder builder()

toBuilder

public abstract RetryConfig.Builder toBuilder()