Control the Cloud C++ client library behavior with respect to polling on long running operations.
Some operations in Cloud services return a google.longrunning.Operation object. As their name implies, these objects represent requests that may take a long time to complete, in some cases operations may take tens of seconds or even 30 minutes to complete.
The Cloud C++ client libraries models these long running operations as a google::cloud::future<StatusOr<T>>, where T represents the final result of the operation. In the background, the library polls the service until the operation completes (or fails) and then satisfies the future.
This class defines the interface for policies that control the behavior of this polling loop.
This function is called at the beginning of the polling loop. Policies that are based on relative time should restart their timers when this function is called.
Returns
Type
Description
std::unique_ptr< PollingPolicy >
OnFailure(Status const &)
A callback to indicate that a polling attempt failed.
This is called when a polling request fails. Note that this callback is not invoked when the polling request succeeds with "operation not done".
Parameter
Name
Description
status
Status const &
Returns
Type
Description
bool
true if the failure should be treated as transient and the polling loop should continue.
WaitPeriod()
How long should the polling loop wait before trying again.
[[["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-03-05 UTC."],[[["This page details the `PollingPolicy` class within the Google Cloud C++ client library, which controls how long-running operations are polled for completion."],["The library models long-running operations using `google::cloud::future\u003cStatusOr\u003cT\u003e\u003e`, automatically polling the service in the background until the operation is finished."],["The `PollingPolicy` class offers methods such as `clone()`, `OnFailure()`, and `WaitPeriod()` to manage polling behavior, including copying the policy, handling failures, and setting the wait time between polling attempts."],["The latest version of the documentated reference is 2.37.0-rc, with a full list of previous versions available for viewing."],["The document is related to polling on long-running operations that may take a long period of time to complete, and the `PollingPolicy` class has been designed to help manage this."]]],[]]
