RetryParams (App Engine Client for Google Cloud Storage 0.6 API)

com.google.appengine.tools.cloudstorage

Class RetryParams

• java.lang.Object
• • com.google.appengine.tools.cloudstorage.RetryParams

• All Implemented Interfaces:

  Serializable

  ---

  
  

  public final class RetryParams
  extends Object
  implements Serializable

  Parameters for configuring exponential backoff. See RetryHelper. The initial request is executed immediately. It is given requestTimeoutMillis to complete or it is regarded as a failure. If the request fails the calling thread sleeps for initialRetryDelayMillis. Each subsequent failure the sleep interval is calculated as at least half of and no more than:

   initialRetryDelayMillis *  retryDelayBackoffFactor ^ NumFailures
  

  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 getDefaultInstance(). Default settings are subject to change release to release. If you require specific settings, explicitly create an instance of RetryParams with the required settings.

  See Also:

  Serialized Form

• • Nested Class Summary

    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_REQUEST_TIMEOUT
    static long	DEFAULT_MAX_RETRY_DELAY_MILLIS
    static long	DEFAULT_REQUEST_TIMEOUT_MILLIS
    static double	DEFAULT_REQUEST_TIMEOUT_RETRY_FACTOR
    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

  • Method Summary

    All Methods Static Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    boolean	equals(Object obj)
    static RetryParams	getDefaultInstance() Retrieve an instance with the default parameters
    long	getInitialRetryDelayMillis()
    long	getMaxRetryDelayMillis()
    long	getRequestTimeoutMillis()
    double	getRetryDelayBackoffFactor()
    int	getRetryMaxAttempts()
    int	getRetryMinAttempts()
    long	getTotalRetryPeriodMillis()
    int	hashCode()
    String	toString()

    • Methods inherited from class java.lang.Object

      clone, finalize, getClass, notify, notifyAll, wait, wait, wait

• • Field Detail

    • DEFAULT_REQUEST_TIMEOUT_MILLIS

      public static final long DEFAULT_REQUEST_TIMEOUT_MILLIS

      See Also:

      Constant Field Values

    • DEFAULT_REQUEST_TIMEOUT_RETRY_FACTOR

      public static final double DEFAULT_REQUEST_TIMEOUT_RETRY_FACTOR

      See Also:

      Constant Field Values

    • DEFAULT_MAX_REQUEST_TIMEOUT

      public static final long DEFAULT_MAX_REQUEST_TIMEOUT

      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

    • DEFAULT_TOTAL_RETRY_PERIOD_MILLIS

      public static final long DEFAULT_TOTAL_RETRY_PERIOD_MILLIS

      See Also:

      Constant Field Values

  • Method Detail

    • getDefaultInstance

      public static RetryParams getDefaultInstance()

      Retrieve an instance with the default parameters

    • getRetryMinAttempts

      public int getRetryMinAttempts()

      Returns:

      the retryMinAttempts

    • getRetryMaxAttempts

      public int getRetryMaxAttempts()

      Returns:

      the retryMaxAttempts

    • getInitialRetryDelayMillis

      public long getInitialRetryDelayMillis()

      Returns:

      the initialRetryDelayMillis

    • getMaxRetryDelayMillis

      public long getMaxRetryDelayMillis()

      Returns:

      the maxRetryDelayMillis

    • getRetryDelayBackoffFactor

      public double getRetryDelayBackoffFactor()

      Returns:

      the maxRetryDelayBackoffFactor

    • getTotalRetryPeriodMillis

      public long getTotalRetryPeriodMillis()

      Returns:

      the totalRetryPeriodMillis

    • getRequestTimeoutMillis

      public long getRequestTimeoutMillis()

      Returns:

      the requestTimeoutMillis

    • 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

Copyright © 2016 Google. All rights reserved.