Skip to main content

Credential

Struct Credential 

Source
pub struct Credential {
    pub service_account: Option<ServiceAccount>,
    pub token: Option<Token>,
    pub signer_email: Option<String>,
}
Expand description

Credential represents Google credentials that may contain a service account, token, and provider-discovered signer identity.

IMPORTANT: This is a specially designed structure that can hold both ServiceAccount and Token simultaneously. This design is intentional and critical for Google’s authentication:

  • Service account only: Used for signed URL generation and JWT-based authentication
  • Token only: Used for Bearer authentication (e.g., from metadata server, OAuth2)
  • Token with signer email: Also supports query signing through IAMCredentials signBlob
  • Both: The RequestSigner is responsible for exchanging service account for tokens when needed, and can use cached tokens when available to avoid unnecessary exchanges

The RequestSigner implementation handles the logic of when to use which credential type and when to perform token exchanges. Discovery providers should return credentials as they receive them without trying to perform exchanges themselves. Explicit conversion providers may return a new variant, such as a token-only credential produced from a service account.

Fields§

§service_account: Option<ServiceAccount>

Service account information, if available.

§token: Option<Token>

OAuth2 access token, if available.

§signer_email: Option<String>

Service account email authorized to sign with the token, if known by the provider.

This identity is used only for query signing and does not affect Bearer authentication.

Implementations§

Source§

impl Credential

Source

pub fn with_service_account(service_account: ServiceAccount) -> Self

Create a credential with only a service account.

Source

pub fn with_token(token: Token) -> Self

Create a credential with a token.

Source

pub fn with_signer_email(self, signer_email: impl Into<String>) -> Self

Set the service account email authorized to sign with this credential’s token.

This identity is used only for query signing and does not affect Bearer authentication.

Source

pub fn has_service_account(&self) -> bool

Check if the credential has a service account.

Source

pub fn has_token(&self) -> bool

Check if the credential has a token.

Source

pub fn has_valid_token(&self) -> bool

Check if the credential has a valid token.

Trait Implementations§

Source§

impl Clone for Credential

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Credential

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Credential

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl SigningCredential for Credential

Source§

fn is_valid(&self) -> bool

Return whether a cached credential can be reused without refreshing it. Read more
Source§

fn is_valid_at(&self, timestamp: Timestamp) -> bool

Return whether the credential is usable at this exact timestamp. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V