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."],[[["This webpage details the `AccessTokenGenerator` class, which is used to generate OAuth2 access tokens for authenticating with Google Cloud Platform and other Google services."],["The latest version, 2.37.0-rc, along with several previous versions of the `AccessTokenGenerator` class, are available for review and access via links."],["Generating a new access token can be expensive due to HTTP calls or cryptographic operations, so it is recommended to retain `AccessTokenGenerator` instances for as long as possible and rely on the class's internal caching mechanisms."],["The `AccessTokenGenerator` class is thread-safe, and it uses `StatusOr\u003cT\u003e` for error handling, providing error details when an operation fails and a true `ok()` member function when the operation was successful."],["The main function, `GetToken()`, returns a cached OAuth2 access token to avoid the cost of recalculation on every function call."]]],[]]
