Defines the interface for access token generators.
Instances of this class can generate OAuth2 access tokens. These are used to authenticate with Google Cloud Platform (and other Google Services), and may be useful for applications that directly invoke REST-based services.
Performance
Creating a new access token is relatively expensive. It may require remote calls via HTTP, or at the very least some (local) cryptographic operations.
Most implementations of this class will cache an access token until it is about to expire. Application developers are advised to keep AccessTokenGenerator instances for as long as possible. They should also avoid caching the access token themselves, as caching is already provided by the implementation.
Thread Safety
It is safe to call an instance of this class from two separate threads.
Error Handling
This class uses StatusOr<T> to report errors. When an operation fails to perform its work the returned StatusOr<T> contains the error details. If the ok() member function in the StatusOr<T> returns true then it contains the expected result. Please consult the google::cloud::StatusOr documentation for more details.
Functions
GetToken()
Returns an OAuth2 access token.
This function caches the access token to avoid the cost of recomputing the token on each call.
[[["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-14 UTC."],[[["The latest version of the `AccessTokenGenerator` interface is 2.37.0-rc, and it defines how to generate OAuth2 access tokens for authenticating with Google Cloud Platform and other Google Services."],["Creating a new access token is resource-intensive, involving remote HTTP calls or cryptographic operations, so the class implementations will cache the tokens until they are about to expire, advising users not to do the same."],["Instances of the `AccessTokenGenerator` class are thread-safe, allowing them to be called from multiple threads concurrently."],["The class utilizes `StatusOr\u003cT\u003e` to handle errors, where `ok()` being true indicates success, and failure details are contained within the `StatusOr\u003cT\u003e`."],["The `GetToken()` function retrieves an OAuth2 access token and caches it to avoid the overhead of recalculating the token with each invocation."]]],[]]
