Package com.google.api.client.http
Interface BackOffPolicy
-
- All Known Implementing Classes:
ExponentialBackOffPolicy
@Deprecated @Beta public interface BackOffPolicy
Deprecated.(scheduled to be removed in 1.18) UseHttpBackOffUnsuccessfulResponseHandler
instead.Beta
Strategy interface to control back off between retry attempts.- Since:
- 1.7
-
-
Field Summary
Fields Modifier and Type Field Description static long
STOP
Deprecated.Value indicating that no more retries should be made, seegetNextBackOffMillis()
.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description long
getNextBackOffMillis()
Deprecated.Gets the number of milliseconds to wait before retrying an HTTP request.boolean
isBackOffRequired(int statusCode)
Deprecated.Determines if back off is required based on the specified status code.void
reset()
Deprecated.Reset Back off counters (if any) in an implementation-specific fashion.
-
-
-
Field Detail
-
STOP
static final long STOP
Deprecated.Value indicating that no more retries should be made, seegetNextBackOffMillis()
.- See Also:
- Constant Field Values
-
-
Method Detail
-
isBackOffRequired
boolean isBackOffRequired(int statusCode)
Deprecated.Determines if back off is required based on the specified status code.Implementations may want to back off on server or product-specific errors.
- Parameters:
statusCode
- HTTP status code
-
reset
void reset()
Deprecated.Reset Back off counters (if any) in an implementation-specific fashion.
-
getNextBackOffMillis
long getNextBackOffMillis() throws java.io.IOException
Deprecated.Gets the number of milliseconds to wait before retrying an HTTP request. IfSTOP
is returned, no retries should be made.This method should be used as follows:
long backoffTime = backoffPolicy.getNextBackoffMs(); if (backoffTime == BackoffPolicy.STOP) { // Stop retrying. } else { // Retry after backoffTime. }
- Returns:
- the number of milliseconds to wait when backing off requests, or
STOP
if no more retries should be made - Throws:
java.io.IOException
-
-