Struct CreateBasinRequest 

pub struct CreateBasinRequest {
    pub basin: BasinName,
    pub config: Option<BasinConfig>,
    pub scope: Option<BasinScope>,
}

Create basin request.

Fields

basin: BasinName

Basin name, which must be globally unique. The name must be between 8 and 48 characters, comprising lowercase letters, numbers and hyphens. It cannot begin or end with a hyphen.

config: Option<BasinConfig>

Basin configuration.

scope: Option<BasinScope>

Basin scope.

Implementations

impl CreateBasinRequest

pub fn new(basin: BasinName) -> Self

Create a new request with basin name.

Examples found in repository

examples/create_basin.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let basin: BasinName = "my-favorite-basin".parse()?;

    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Set the default retention age to 10 days.
        Duration::from_secs(10 * 24 * 60 * 60),
    ));

    let basin_config = BasinConfig::new()
        .with_default_stream_config(default_stream_config)
        .with_create_stream_on_append(false)
        .with_create_stream_on_read(false);

    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);

    let created_basin = client.create_basin(create_basin_request).await?;
    println!("{created_basin:#?}");

    let basin_config = client.get_basin_config(basin).await?;
    println!("{basin_config:#?}");

    Ok(())
}

pub fn with_config(self, config: BasinConfig) -> Self

Overwrite basin configuration.

Examples found in repository

examples/create_basin.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let basin: BasinName = "my-favorite-basin".parse()?;

    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Set the default retention age to 10 days.
        Duration::from_secs(10 * 24 * 60 * 60),
    ));

    let basin_config = BasinConfig::new()
        .with_default_stream_config(default_stream_config)
        .with_create_stream_on_append(false)
        .with_create_stream_on_read(false);

    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);

    let created_basin = client.create_basin(create_basin_request).await?;
    println!("{created_basin:#?}");

    let basin_config = client.get_basin_config(basin).await?;
    println!("{basin_config:#?}");

    Ok(())
}

pub fn with_scope(self, scope: BasinScope) -> Self

Overwrite basin scope.

Trait Implementations

impl Clone for CreateBasinRequest

fn clone(&self) -> CreateBasinRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBasinRequest

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

Formats the value using the given formatter.