target.apidocs.com.google.api.services.compute.model.HttpRetryPolicy.html Maven / Gradle / Ivy
HttpRetryPolicy (Compute Engine API v1-rev20200104-1.30.8)
com.google.api.services.compute.model
Class HttpRetryPolicy
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.compute.model.HttpRetryPolicy
-
public final class HttpRetryPolicy
extends GenericJson
The retry policy associates with HttpRouteRule
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
HttpRetryPolicy()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
HttpRetryPolicy
clone()
Long
getNumRetries()
Specifies the allowed number retries.
Duration
getPerTryTimeout()
Specifies a non-zero timeout per retry attempt.
List<String>
getRetryConditions()
Specfies one or more conditions when this retry rule applies.
HttpRetryPolicy
set(String fieldName,
Object value)
HttpRetryPolicy
setNumRetries(Long numRetries)
Specifies the allowed number retries.
HttpRetryPolicy
setPerTryTimeout(Duration perTryTimeout)
Specifies a non-zero timeout per retry attempt.
HttpRetryPolicy
setRetryConditions(List<String> retryConditions)
Specfies one or more conditions when this retry rule applies.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getNumRetries
public Long getNumRetries()
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Returns:
- value or
null for none
-
setNumRetries
public HttpRetryPolicy setNumRetries(Long numRetries)
Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
- Parameters:
numRetries - numRetries or null for none
-
getPerTryTimeout
public Duration getPerTryTimeout()
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in
HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among
all backend services associated with the route.
- Returns:
- value or
null for none
-
setPerTryTimeout
public HttpRetryPolicy setPerTryTimeout(Duration perTryTimeout)
Specifies a non-zero timeout per retry attempt. If not specified, will use the timeout set in
HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among
all backend services associated with the route.
- Parameters:
perTryTimeout - perTryTimeout or null for none
-
getRetryConditions
public List<String> getRetryConditions()
Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx:
Loadbalancer will attempt a retry if the backend service responds with any 5xx response code,
or if the backend service does not respond at all, example: disconnects, reset, read timeout,
connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to
response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures
connecting to backend services, for example due to connection timeouts. - retriable-4xx:
Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error
supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the
stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. -
cancelledLoadbalancer will retry if the gRPC status code in the response header is set to
cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC
status code in the response header is set to resource-exhausted - unavailable: Loadbalancer
will retry if the gRPC status code in the response header is set to unavailable
- Returns:
- value or
null for none
-
setRetryConditions
public HttpRetryPolicy setRetryConditions(List<String> retryConditions)
Specfies one or more conditions when this retry rule applies. Valid values are: - 5xx:
Loadbalancer will attempt a retry if the backend service responds with any 5xx response code,
or if the backend service does not respond at all, example: disconnects, reset, read timeout,
connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to
response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures
connecting to backend services, for example due to connection timeouts. - retriable-4xx:
Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error
supported is 409. - refused-stream:Loadbalancer will retry if the backend service resets the
stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. -
cancelledLoadbalancer will retry if the gRPC status code in the response header is set to
cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response
header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC
status code in the response header is set to resource-exhausted - unavailable: Loadbalancer
will retry if the gRPC status code in the response header is set to unavailable
- Parameters:
retryConditions - retryConditions or null for none
-
set
public HttpRetryPolicy set(String fieldName,
Object value)
- Overrides:
set in class GenericJson
-
clone
public HttpRetryPolicy clone()
- Overrides:
clone in class GenericJson
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy