Struct MetadataService 

pub struct MetadataService { /* private fields */ }

A client that talks to the Google metadata service and gets tokens for the default service account.

This only will work on hosts that are within the GCP network.

See google_cloud_auth::credentials::mds for more details.

Implementations

impl MetadataService

pub async fn metadata_endpoint_exists() -> Result<bool>

Verify whether the metadata.google.internal endpoint exists, and it returns a 2XX.

pub async fn new( oauth_config: &OAuthConfig, scopes: &[impl AsRef<str>], ) -> Result<MetadataService>

Attempt to create an auth client that will contact the metadata service if possible.

To verify that the metadata service is available, see Self::metadata_endpoint_exists

Trait Implementations

impl Debug for MetadataService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TokenSource for MetadataService

fn kind(&self) -> &'static str

A human readable description of this class e.g. “authorized user”

fn credentials<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Credentials> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return a Credentials object that other Google Cloud SDK APIs can use

fn refresh<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Attempt to re-authenticate if possible. This may be an interactive action.

fn get_id_token_impl<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Token, IdTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The actual implementation to fetch an ID token. This varies based on client type.

fn get_id_token_with_refresh<'life0, 'async_trait>( &'life0 self, refresh: bool, ) -> Pin<Box<dyn Future<Output = Result<Token, IdTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Common implementation for getting an id token, or refreshing and retrying if the token is expired.

fn get_id_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Token, IdTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get an id token

fn get_access_token_impl<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Token, AccessTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

The actual implementation to fetch an access token.

fn get_access_token_with_refresh<'life0, 'async_trait>( &'life0 self, refresh: bool, ) -> Pin<Box<dyn Future<Output = Result<Token, AccessTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Common implementation for getting an access token, or refreshing and retrying if the token is expired.

fn get_access_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Token, AccessTokenError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get an access token, refreshing if necessary