Struct Builder

pub struct Builder { /* private fields */ }

A builder for constructing user_account Credentials instance.

Example

let authorized_user = serde_json::json!({ /* add details here */ });
let credentials = Builder::new(authorized_user).build();
})

Implementations

impl Builder

pub fn new(authorized_user: Value) -> Self

Creates a new builder using authorized_user JSON value.

The authorized_user JSON is typically generated when a user authenticates using the application-default login process.

pub fn with_token_uri<S: Into<String>>(self, token_uri: S) -> Self

Sets the URI for the token endpoint used to fetch access tokens.

Any value provided here overrides a token_uri value from the input authorized_user JSON. Defaults to https://oauth2.googleapis.com/token if not specified here or in the authorized_user JSON.

Example

let authorized_user = serde_json::json!({ /* add details here */ });
let credentials = Builder::new(authorized_user)
    .with_token_uri("https://oauth2-FOOBAR.p.googleapis.com")
    .build();

pub fn with_scopes<I, S>(self, scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the scopes for these credentials.

scopes define the permissions being requested for this specific access token when interacting with a service. For example, https://www.googleapis.com/auth/devstorage.read_write. IAM permissions, on the other hand, define the underlying capabilities the user account possesses within a system. For example, storage.buckets.delete. When a token generated with specific scopes is used, the request must be permitted by both the user account’s underlying IAM permissions and the scopes requested for the token. Therefore, scopes act as an additional restriction on what the token can be used for.

Example

let authorized_user = serde_json::json!({ /* add details here */ });
let credentials = Builder::new(authorized_user)
    .with_scopes(["https://www.googleapis.com/auth/pubsub"])
    .build();

pub fn with_quota_project_id<S: Into<String>>(self, quota_project_id: S) -> Self

Sets the quota project for these credentials.

In some services, you can use an account in one project for authentication and authorization, and charge the usage to a different project. This requires that the user has serviceusage.services.use permissions on the quota project.

Any value set here overrides a quota_project_id value from the input authorized_user JSON.

Example

let authorized_user = serde_json::json!("{ /* add details here */ }");
let credentials = Builder::new(authorized_user)
    .with_quota_project_id("my-project")
    .build();

pub fn with_retry_policy<V: Into<RetryPolicyArg>>(self, v: V) -> Self

Configure the retry policy for fetching tokens.

The retry policy controls how to handle retries, and sets limits on the number of attempts or the total time spent retrying.

use gax::retry_policy::{AlwaysRetry, RetryPolicyExt};
let authorized_user = serde_json::json!({
    "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
    "client_secret": "YOUR_CLIENT_SECRET",
    "refresh_token": "YOUR_REFRESH_TOKEN",
    "type": "authorized_user",
});
let credentials = Builder::new(authorized_user)
    .with_retry_policy(AlwaysRetry.with_attempt_limit(3))
    .build();

pub fn with_backoff_policy<V: Into<BackoffPolicyArg>>(self, v: V) -> Self

Configure the retry backoff policy.

The backoff policy controls how long to wait in between retry attempts.

use gax::exponential_backoff::ExponentialBackoff;
let authorized_user = serde_json::json!({
    "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
    "client_secret": "YOUR_CLIENT_SECRET",
    "refresh_token": "YOUR_REFRESH_TOKEN",
    "type": "authorized_user",
});
let credentials = Builder::new(authorized_user)
    .with_backoff_policy(ExponentialBackoff::default())
    .build();

pub fn with_retry_throttler<V: Into<RetryThrottlerArg>>(self, v: V) -> Self

Configure the retry throttler.

Advanced applications may want to configure a retry throttler to Address Cascading Failures and when Handling Overload conditions. The authentication library throttles its retry loop, using a policy to control the throttling algorithm. Use this method to fine tune or customize the default retry throttler.

use gax::retry_throttler::AdaptiveThrottler;
let authorized_user = serde_json::json!({
    "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
    "client_secret": "YOUR_CLIENT_SECRET",
    "refresh_token": "YOUR_REFRESH_TOKEN",
    "type": "authorized_user",
});
let credentials = Builder::new(authorized_user)
    .with_retry_throttler(AdaptiveThrottler::default())
    .build();

pub fn build(self) -> Result<Credentials, Error>

Returns a Credentials instance with the configured settings.

Errors

Returns a CredentialsError if the authorized_user provided to Builder::new cannot be successfully deserialized into the expected format. This typically happens if the JSON value is malformed or missing required fields. For more information, on how to generate authorized_user json, consult the relevant section in the application-default credentials guide.