Stay organized with collections Save and categorize content based on your preferences.
When it is safe to do so, the library automatically retries requests that fail due to a transient error. The library then uses exponential backoff to backoff before trying again. Which operations are considered safe to retry, which errors are treated as transient failures, the details of the exponential backoff algorithm, and for how long the library retries are all configurable via policies.
This document provides examples showing how to override the default policies.
The policies can be set when the *Connection object is created. The library provides default policies for any policy that is not set. The application can also override some (or all) policies when the *Client object is created. This can be useful if multiple *Client objects share the same *Connection object, but you want different retry behavior in some of the clients. Finally, the application can override some retry policies when calling a specific member function.
The library uses three different options to control the retry loop. The options have per-client names.
Configuring the transient errors and retry durationThe *RetryPolicyOption controls:
You can provide your own class for this option. The library also provides two built-in policies:
*LimitedErrorCountRetryPolicy: stops retrying after a specified number of transient errors.*LimitedTimeRetryPolicy: stops retrying after a specified time.Note that a library may have more than one version of these classes. Their name match the *Client and *Connection object they are intended to be used with. Some *Client objects treat different error codes as transient errors. In most cases, only kUnavailable is treated as a transient error.
The *BackoffPolicyOption controls how long the client library will wait before retrying a request that failed with a transient error. You can provide your own class for this option.
The only built-in backoff policy is ExponentialBackoffPolicy. This class implements a truncated exponential backoff algorithm, with jitter. In summary, it doubles the current backoff time after each failure. The actual backoff time for an RPC is chosen at random, but never exceeds the current backoff. The current backoff is doubled after each failure, but never exceeds (or is "truncated") if it reaches a prescribed maximum.
The *IdempotencyPolicyOption controls which requests are retryable, as some requests are never safe to retry.
Only one built-in idempotency policy is provided by the library. The name matches the name of the client it is intended for. For example, FooBarClient will use FooBarIdempotencyPolicy. This policy is very conservative.
For example, this will override the retry policies for networksecurity_v1::NetworkSecurityClient:
auto options = google::cloud::Options{}
.set<google::cloud::networksecurity_v1::
NetworkSecurityConnectionIdempotencyPolicyOption>(
CustomIdempotencyPolicy().clone())
.set<google::cloud::networksecurity_v1::
NetworkSecurityRetryPolicyOption>(
google::cloud::networksecurity_v1::
NetworkSecurityLimitedErrorCountRetryPolicy(3)
.clone())
.set<google::cloud::networksecurity_v1::
NetworkSecurityBackoffPolicyOption>(
google::cloud::ExponentialBackoffPolicy(
/*initial_delay=*/std::chrono::milliseconds(200),
/*maximum_delay=*/std::chrono::seconds(45),
/*scaling=*/2.0)
.clone());
auto connection =
google::cloud::networksecurity_v1::MakeNetworkSecurityConnection(options);
// c1 and c2 share the same retry policies
auto c1 =
google::cloud::networksecurity_v1::NetworkSecurityClient(connection);
auto c2 =
google::cloud::networksecurity_v1::NetworkSecurityClient(connection);
// You can override any of the policies in a new client. This new client
// will share the policies from c1 (or c2) *except* from the retry policy.
auto c3 = google::cloud::networksecurity_v1::NetworkSecurityClient(
connection,
google::cloud::Options{}
.set<google::cloud::networksecurity_v1::
NetworkSecurityRetryPolicyOption>(
google::cloud::networksecurity_v1::
NetworkSecurityLimitedTimeRetryPolicy(std::chrono::minutes(5))
.clone()));
// You can also override the policies in a single call:
// c3.SomeRpc(..., google::cloud::Options{}
// .set<google::cloud::networksecurity_v1::NetworkSecurityRetryPolicyOption>(
// google::cloud::networksecurity_v1::NetworkSecurityLimitedErrorCountRetryPolicy(10).clone()));
This assumes you have created a custom idempotency policy. Such as:
class CustomIdempotencyPolicy : public google::cloud::networksecurity_v1::
NetworkSecurityConnectionIdempotencyPolicy {
public:
~CustomIdempotencyPolicy() override = default;
std::unique_ptr<google::cloud::networksecurity_v1::
NetworkSecurityConnectionIdempotencyPolicy>
clone() const override {
return std::make_unique<CustomIdempotencyPolicy>(*this);
}
// Override inherited functions to define as needed.
};
google::cloud::ExponentialBackoffPolicy
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["The library automatically retries requests that fail due to transient errors, using exponential backoff for subsequent attempts, with configurable policies that determine which operations are safe to retry, which errors are transient, and the duration of retries."],["There are three main options to control the retry loop: `*RetryPolicyOption` to define transient errors and retry duration, `*BackoffPolicyOption` to manage the backoff algorithm, and `*IdempotencyPolicyOption` to determine which operations are retryable."],["The library offers built-in policies like `*LimitedErrorCountRetryPolicy`, `*LimitedTimeRetryPolicy`, and `ExponentialBackoffPolicy`, and users can also create their own custom policies, like `CustomIdempotencyPolicy`, to override default behaviors."],["Policies can be configured when creating the `*Connection` object, `*Client` object, or even during a specific member function call, allowing for flexible control over retry behavior at different levels of granularity."],["The latest version of the documentation is the \"2.37.0-rc\" release candidate and the webpage provides a list of other releases ranging from 2.13.0 to 2.36.0, showing the history and versions of the network security overrides."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4