Struct CreateBasinInput 

#[non_exhaustive]
pub struct CreateBasinInput {
    pub name: BasinName,
    pub config: Option<BasinConfig>,
    pub scope: Option<BasinScope>,
    pub idempotency_token: String,
}

Input for create_basin operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: BasinName

Basin name.

config: Option<BasinConfig>

Configuration for the basin.

See BasinConfig for defaults.

scope: Option<BasinScope>

Scope of the basin.

Defaults to AwsUsEast1.

idempotency_token: String

Idempotency token for the operation.

When a request is retried, the same token is reused, causing the server to return the original response instead of performing the operation again.

Defaults to a random UUID.

Implementations

impl CreateBasinInput

pub fn new(name: BasinName) -> Self

Create a new CreateBasinInput with the given basin name.

Examples found in repository

examples/create_basin.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = CreateBasinInput::new(basin_name.clone()).with_config(
        BasinConfig::new().with_default_stream_config(
            StreamConfig::new().with_retention_policy(RetentionPolicy::Age(10 * 24 * 60 * 60)),
        ),
    );
    let basin_info = s2.create_basin(input).await?;
    println!("{basin_info:#?}");

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

    Ok(())
}

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

Set the configuration for the basin.

Examples found in repository

examples/create_basin.rs (lines 17-21)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = CreateBasinInput::new(basin_name.clone()).with_config(
        BasinConfig::new().with_default_stream_config(
            StreamConfig::new().with_retention_policy(RetentionPolicy::Age(10 * 24 * 60 * 60)),
        ),
    );
    let basin_info = s2.create_basin(input).await?;
    println!("{basin_info:#?}");

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

    Ok(())
}

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

Set the scope of the basin.

pub fn with_idempotency_token( self, idempotency_token: impl Into<String>, ) -> Self

Set the idempotency token for the operation.

Trait Implementations

impl Clone for CreateBasinInput

fn clone(&self) -> CreateBasinInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBasinInput

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

Formats the value using the given formatter.

impl From<CreateBasinInput> for (CreateBasinRequest, String)

fn from(value: CreateBasinInput) -> Self

Converts to this type from the input type.