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 webpage details different versions of the `PollingPolicy` class within the Google Cloud C++ client library, ranging from version 2.10.1 up to the latest release candidate, 2.37.0-rc."],["The `PollingPolicy` class governs how the C++ client library manages polling for long-running operations, which are operations that take significant time to finish, returning a `google.longrunning.Operation` object."],["The library represents long-running operations as a `google::cloud::future` that polls until the operation completes or fails, and the `PollingPolicy` controls the polling loop's behavior."],["The `PollingPolicy` interface includes functions such as `clone()`, `OnFailure()`, and `WaitPeriod()` that dictate how a polling loop begins, handles failures, and determines wait times between polling attempts, respectively."],["Further details regarding the nature of long-running operations can be found at \u003chttps://aip.dev/151\u003e."]]],[]]
