Struct CreateBasinInput 

#[non_exhaustive]
pub struct CreateBasinInput {
    pub name: BasinName,
    pub config: Option<BasinConfig>,
    pub location: Option<LocationName>,
    /* private fields */
}

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.

location: Option<LocationName>

Location of the basin.

If omitted when creating, uses the default location for the account.

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(())
}

examples/docs_account_and_basins.rs (line 29)

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

    let client = S2::new(S2Config::new(access_token))?;

    // ANCHOR: basin-operations
    // List basins
    let basins = client.list_basins(ListBasinsInput::new()).await?;

    // Create a basin
    client
        .create_basin(CreateBasinInput::new("my-events".parse()?))
        .await?;

    // Get configuration
    let config = client.get_basin_config("my-events".parse()?).await?;

    // Delete
    client
        .delete_basin(DeleteBasinInput::new("my-events".parse()?))
        .await?;
    // ANCHOR_END: basin-operations
    println!("Basins: {:?}, config: {:?}", basins, config);

    let basin = client.basin(basin_name);

    // ANCHOR: stream-operations
    // List streams
    let streams = basin
        .list_streams(ListStreamsInput::new().with_prefix("user-".parse()?))
        .await?;

    // Create a stream
    // Optionally, pass `.with_config(StreamConfig { .. })` to CreateStreamInput.
    basin
        .create_stream(CreateStreamInput::new("user-actions".parse()?))
        .await?;

    // Get configuration
    let config = basin.get_stream_config("user-actions".parse()?).await?;

    // Delete
    basin
        .delete_stream(DeleteStreamInput::new("user-actions".parse()?))
        .await?;
    // ANCHOR_END: stream-operations
    println!("Streams: {:?}, config: {:?}", streams, config);

    // ANCHOR: access-token-basic
    // List tokens (returns metadata, not the secret)
    let tokens = client.list_access_tokens(Default::default()).await?;

    // Issue a token scoped to streams under "users/1234/"
    let result = client
        .issue_access_token(
            IssueAccessTokenInput::new(
                "user-1234-rw-token".parse()?,
                AccessTokenScopeInput::from_op_group_perms(
                    OperationGroupPermissions::new()
                        .with_stream(ReadWritePermissions::read_write()),
                )
                .with_basins(BasinMatcher::Prefix("".parse()?)) // all basins
                .with_streams(StreamMatcher::Prefix("users/1234/".parse()?)),
            )
            .with_expires_at("2027-01-01T00:00:00Z".parse()?),
        )
        .await?;

    // Revoke a token
    client
        .revoke_access_token("user-1234-rw-token".parse()?)
        .await?;
    // ANCHOR_END: access-token-basic
    println!("Tokens: {:?}, issued: {:?}", tokens, result);

    // ANCHOR: access-token-restricted
    client
        .issue_access_token(IssueAccessTokenInput::new(
            "restricted-token".parse()?,
            AccessTokenScopeInput::from_op_group_perms(
                OperationGroupPermissions::new().with_stream(ReadWritePermissions::read_only()),
            )
            .with_basins(BasinMatcher::Exact("production".parse()?))
            .with_streams(StreamMatcher::Prefix("logs/".parse()?)),
        ))
        .await?;
    // ANCHOR_END: access-token-restricted

    // Pagination examples - not executed by default
    if false {
        // ANCHOR: pagination
        // Iterate through all streams with automatic pagination
        let mut stream = basin.list_all_streams(ListAllStreamsInput::new());
        while let Some(info) = stream.next().await {
            let info = info?;
            println!("{}", info.name);
        }
        // ANCHOR_END: pagination

        // ANCHOR: pagination-filtering
        // List streams with a prefix filter
        let input = ListAllStreamsInput::new().with_prefix("events/".parse()?);
        let mut stream = basin.list_all_streams(input);
        while let Some(info) = stream.next().await {
            println!("{}", info?.name);
        }
        // ANCHOR_END: pagination-filtering

        // ANCHOR: pagination-deleted
        // Include streams that are being deleted
        let input = ListAllStreamsInput::new().with_include_deleted(true);
        let mut stream = basin.list_all_streams(input);
        while let Some(info) = stream.next().await {
            let info = info?;
            println!("{} {:?}", info.name, info.deleted_at);
        }
        // ANCHOR_END: pagination-deleted
    }

    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_location<S>(self, location: S) -> Result<Self, ValidationError>

where S: TryInto<LocationName>, S::Error: Display,

Set the location of the basin.

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.