Struct ApiKeyBuilder

pub struct ApiKeyBuilder { /* private fields */ }

Builder for ApiKeyRequest.

Implementations

impl ApiKeyBuilder

pub fn api_key_id<VALUE: Into<String>>(self, value: VALUE) -> Self

API key identifier

pub fn credentials<VALUE: Into<Credentials>>(self, value: VALUE) -> Self

Credentials for authentication (not serialized)

pub fn build(self) -> Result<ApiKeyRequest, ApiKeyBuilderError>

Builds a new ApiKeyRequest.

Errors

If a required field has not been initialized.

impl ApiKeyBuilder

pub async fn create(self) -> ApiResponseOrError<ApiKey>

Creates a new API key request and returns the response.

This is a convenience method that builds the request from the builder and sends it to the API Keys API.

Example

let credentials = Credentials::from_env();

let api_key = ApiKey::builder("api_key_123456789")
    .credentials(credentials)
    .create()
    .await?;

Trait Implementations

impl Clone for ApiKeyBuilder

fn clone(&self) -> ApiKeyBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyBuilder

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

Formats the value using the given formatter.

impl Default for ApiKeyBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ApiKeyBuilder

fn eq(&self, other: &ApiKeyBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiKeyBuilder