RetryParams (GCloud Java core 0.2.2 API)

java.lang.Object
- com.google.cloud.RetryParams

All Implemented Interfaces:

Serializable
```
public final class RetryParams
extends Object
implements Serializable
```
Parameters for configuring retries with an exponential backoff. Initial request is executed immediately. If the request fails but passes the ExceptionHandler criteria the calling thread sleeps for initialRetryDelayMillis. Each subsequent failure the sleep interval is calculated as:
retryDelayBackoffFactor ^ attempts * initialRetryDelayMillis but would be upper-bounded to maxRetryDelayMillis
This proceeds until either the request is successful, retryMaxAttempts are made, or both retryMinAttempts are made and totalRetryPeriodMillis have elapsed. To construct RetryParams, first create a RetryParams.Builder. The builder is mutable and each of the parameters can be set (any unset parameters will fallback to the defaults). The Builder can be then used to create an immutable RetryParams object. For default RetryParams use defaultInstance(). Default settings are subject to change release to release. If you require specific settings, explicitly create an instance of RetryParams with all the required settings.

See Also:
RetryHelper, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RetryParams.Builder
RetryParams builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RetryParams.Builder` RetryParams builder.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_INITIAL_RETRY_DELAY_MILLIS`
`static long`	`DEFAULT_MAX_RETRY_DELAY_MILLIS`
`static double`	`DEFAULT_RETRY_DELAY_BACKOFF_FACTOR`
`static int`	`DEFAULT_RETRY_MAX_ATTEMPTS`
`static int`	`DEFAULT_RETRY_MIN_ATTEMPTS`
`static long`	`DEFAULT_TOTAL_RETRY_PERIOD_MILLIS` Note that App Engine Standard Environment front-end modules have a 60 second deadline for HTTP requests.

Method Summary

Methods
Modifier and Type	Method and Description
`static RetryParams.Builder`	`builder()`
`static RetryParams`	`defaultInstance()` Returns an instance with the default parameters.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`long`	`initialRetryDelayMillis()` Returns the initialRetryDelayMillis.
`long`	`maxRetryDelayMillis()` Returns the maxRetryDelayMillis.
`static RetryParams`	`noRetries()` Returns an instance of `RetryParams` where `retryMaxAttempts` and `retryMinAttempts` are set to `1`.
`double`	`retryDelayBackoffFactor()` Returns the maxRetryDelayBackoffFactor.
`int`	`retryMaxAttempts()` Returns the retryMaxAttempts.
`int`	`retryMinAttempts()` Returns the retryMinAttempts.
`RetryParams.Builder`	`toBuilder()`
`String`	`toString()`
`long`	`totalRetryPeriodMillis()` Returns the totalRetryPeriodMillis.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_TOTAL_RETRY_PERIOD_MILLIS
```
public static final long DEFAULT_TOTAL_RETRY_PERIOD_MILLIS
```
    Note that App Engine Standard Environment front-end modules have a 60 second deadline for HTTP requests. For that reason, we set the default total retry period to less than 60 seconds.
    
    See Also:
    Constant Field Values
  - DEFAULT_RETRY_MIN_ATTEMPTS
```
public static final int DEFAULT_RETRY_MIN_ATTEMPTS
```
    See Also:
    Constant Field Values
  - DEFAULT_RETRY_MAX_ATTEMPTS
```
public static final int DEFAULT_RETRY_MAX_ATTEMPTS
```
    See Also:
    Constant Field Values
  - DEFAULT_INITIAL_RETRY_DELAY_MILLIS
```
public static final long DEFAULT_INITIAL_RETRY_DELAY_MILLIS
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_RETRY_DELAY_MILLIS
```
public static final long DEFAULT_MAX_RETRY_DELAY_MILLIS
```
    See Also:
    Constant Field Values
  - DEFAULT_RETRY_DELAY_BACKOFF_FACTOR
```
public static final double DEFAULT_RETRY_DELAY_BACKOFF_FACTOR
```
    See Also:
    Constant Field Values
- Method Detail
  - defaultInstance
```
public static RetryParams defaultInstance()
```
    Returns an instance with the default parameters.
  - noRetries
```
public static RetryParams noRetries()
```
    Returns an instance of RetryParams where `retryMaxAttempts` and `retryMinAttempts` are set to `1`.
  - retryMinAttempts
```
public int retryMinAttempts()
```
    Returns the retryMinAttempts. Default value is 3.
  - retryMaxAttempts
```
public int retryMaxAttempts()
```
    Returns the retryMaxAttempts. Default value is 6.
  - initialRetryDelayMillis
```
public long initialRetryDelayMillis()
```
    Returns the initialRetryDelayMillis. Default value is 1000L.
  - maxRetryDelayMillis
```
public long maxRetryDelayMillis()
```
    Returns the maxRetryDelayMillis. Default values is 32000L.
  - retryDelayBackoffFactor
```
public double retryDelayBackoffFactor()
```
    Returns the maxRetryDelayBackoffFactor. Default values is 2.0.
  - totalRetryPeriodMillis
```
public long totalRetryPeriodMillis()
```
    Returns the totalRetryPeriodMillis. Default value is 50000L.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builder
```
public static RetryParams.Builder builder()
```
  - toBuilder
```
public RetryParams.Builder toBuilder()
```

Class RetryParams

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TOTAL_RETRY_PERIOD_MILLIS

DEFAULT_RETRY_MIN_ATTEMPTS

DEFAULT_RETRY_MAX_ATTEMPTS

DEFAULT_INITIAL_RETRY_DELAY_MILLIS

DEFAULT_MAX_RETRY_DELAY_MILLIS

DEFAULT_RETRY_DELAY_BACKOFF_FACTOR

Method Detail

defaultInstance

noRetries

retryMinAttempts

retryMaxAttempts

initialRetryDelayMillis

maxRetryDelayMillis

retryDelayBackoffFactor

totalRetryPeriodMillis

hashCode

equals

toString

builder

toBuilder