Struct ApiKeyCredentialBuilder 

pub struct ApiKeyCredentialBuilder { /* private fields */ }

Configures validation, HTTP transport, and the first API-key exchange.

Obtain this from ApiKeyCredential::builder. The default timeout is ten seconds and covers connecting and receiving the response. An injected HTTP client can configure proxies or test transport. Redirects are disabled when the client is built.

Implementations

impl ApiKeyCredentialBuilder

pub fn exchange_timeout(self, exchange_timeout: Duration) -> Self

Sets the maximum duration of each exchange, including connection and response.

The default is ten seconds. A zero timeout is rejected by Self::build. The timeout also bounds waiting for a fresh token after Dex rejects a unary call.

pub fn http_client(self, http_client: ClientBuilder) -> Self

Configures the HTTP client for token exchange.

This supports proxy settings and test transport. Redirects are always disabled so the API key is never sent to a redirect target. Each request uses the exchange timeout.

pub async fn build(self) -> Result<ApiKeyCredential, ApiKeyCredentialError>

Validates settings, exchanges the key once, and starts automatic refresh.

The URL must use HTTPS, except localhost, IPv4 loopback addresses, and ::1 may use HTTP. The server ID is supplied by the application and is never inferred from the URL. This must run inside a Tokio runtime. No background task remains if the initial exchange fails. See ApiKeyCredential for a complete example and lifecycle details.

Errors

Returns ApiKeyCredentialError for an empty value, invalid or disallowed URL, zero timeout, HTTP client setup failure, transport failure, timeout, rejected HTTP status, or malformed response. The error names the URL and status without exposing secrets.

Trait Implementations

impl Debug for ApiKeyCredentialBuilder

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

Formats the value using the given formatter.