Struct b2_client::account::CreateKeyBuilder

pub struct CreateKeyBuilder { /* private fields */ }

A builder to create a CreateKey object.

After creating the CreateKey, pass it to create_key to obtain a new application key.

See https://www.backblaze.com/b2/docs/b2_create_key.html for more information.

Implementations

impl CreateKeyBuilder

pub fn name<S: Into<String>>(self, name: S) -> Result<Self, ValidationError>

Create a new builder, with the key’s name provided.

pub fn capabilities<V: Into<Vec<Capability>>>(
    self,
    caps: V
) -> Result<Self, ValidationError>

Create the key with the specified capabilities.

At least one capability must be provided.

pub fn expires_after(self, dur: Duration) -> Result<Self, ValidationError>

Set an expiration duration for the key.

If provided, the key must be positive and no more than 1,000 days.

pub fn limit_to_bucket<S: Into<String>>(
    self,
    id: S
) -> Result<Self, ValidationError>

Limit the key’s access to the specified bucket.

pub fn name_prefix<S: Into<String>>(
    self,
    prefix: S
) -> Result<Self, ValidationError>

Limit access to files to those that begin with the specified prefix.

pub fn build<'a>(self) -> Result<CreateKey<'a>, ValidationError>

Create a new CreateKey.

Trait Implementations

impl Default for CreateKeyBuilder

fn default() -> CreateKeyBuilder

Returns the “default value” for a type.