s2::types

Struct BasinConfig

pub struct BasinConfig {
    pub default_stream_config: Option<StreamConfig>,
    pub create_stream_on_append: bool,
    pub create_stream_on_read: bool,
}

Expand description

Basin configuration.

Fields§

§default_stream_config: Option<StreamConfig>

Default stream configuration.

§create_stream_on_append: bool

Create stream on append if it doesn’t exist, using the default stream configuration.

§create_stream_on_read: bool

Create stream on read if it doesn’t exist, using the default stream configuration.

Implementations§

Source §

impl BasinConfig

Source

pub fn new() -> Self

Create a new basin config.

Examples found in repository ?

examples/create_basin.rs (line 21)

9async fn main() -> Result<(), Box<dyn std::error::Error>> {
10    let token = std::env::var("S2_ACCESS_TOKEN")?;
11    let config = ClientConfig::new(token);
12    let client = Client::new(config);
13
14    let basin: BasinName = "my-favorite-basin".parse()?;
15
16    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
17        // Set the default retention age to 10 days.
18        Duration::from_secs(10 * 24 * 60 * 60),
19    ));
20
21    let basin_config = BasinConfig::new()
22        .with_default_stream_config(default_stream_config)
23        .with_create_stream_on_append(false)
24        .with_create_stream_on_read(false);
25
26    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);
27
28    let created_basin = client.create_basin(create_basin_request).await?;
29    println!("{created_basin:#?}");
30
31    let basin_config = client.get_basin_config(basin).await?;
32    println!("{basin_config:#?}");
33
34    Ok(())
35}

More examples

Hide additional examples

examples/reconfigure_basin.rs (line 16)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let basin: BasinName = "my-favorite-basin".parse()?;
13
14    let default_stream_config_updates =
15        StreamConfig::new().with_storage_class(StorageClass::Standard);
16    let basin_config_updates = BasinConfig::new()
17        .with_default_stream_config(default_stream_config_updates)
18        .with_create_stream_on_append(true)
19        .with_create_stream_on_read(true);
20
21    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
22        .with_config(basin_config_updates)
23        // Field mask specifies which fields to update.
24        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);
25
26    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;
27
28    println!("{updated_basin_config:#?}");
29
30    Ok(())
31}

Source

pub fn with_default_stream_config( self, default_stream_config: StreamConfig, ) -> Self

Overwrite the default stream config.

Examples found in repository ?

examples/create_basin.rs (line 22)

9async fn main() -> Result<(), Box<dyn std::error::Error>> {
10    let token = std::env::var("S2_ACCESS_TOKEN")?;
11    let config = ClientConfig::new(token);
12    let client = Client::new(config);
13
14    let basin: BasinName = "my-favorite-basin".parse()?;
15
16    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
17        // Set the default retention age to 10 days.
18        Duration::from_secs(10 * 24 * 60 * 60),
19    ));
20
21    let basin_config = BasinConfig::new()
22        .with_default_stream_config(default_stream_config)
23        .with_create_stream_on_append(false)
24        .with_create_stream_on_read(false);
25
26    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);
27
28    let created_basin = client.create_basin(create_basin_request).await?;
29    println!("{created_basin:#?}");
30
31    let basin_config = client.get_basin_config(basin).await?;
32    println!("{basin_config:#?}");
33
34    Ok(())
35}

More examples

Hide additional examples

examples/reconfigure_basin.rs (line 17)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let basin: BasinName = "my-favorite-basin".parse()?;
13
14    let default_stream_config_updates =
15        StreamConfig::new().with_storage_class(StorageClass::Standard);
16    let basin_config_updates = BasinConfig::new()
17        .with_default_stream_config(default_stream_config_updates)
18        .with_create_stream_on_append(true)
19        .with_create_stream_on_read(true);
20
21    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
22        .with_config(basin_config_updates)
23        // Field mask specifies which fields to update.
24        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);
25
26    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;
27
28    println!("{updated_basin_config:#?}");
29
30    Ok(())
31}

Source

pub fn with_create_stream_on_append(self, create_stream_on_append: bool) -> Self

Overwrite create_stream_on_append.

Examples found in repository ?

examples/create_basin.rs (line 23)

9async fn main() -> Result<(), Box<dyn std::error::Error>> {
10    let token = std::env::var("S2_ACCESS_TOKEN")?;
11    let config = ClientConfig::new(token);
12    let client = Client::new(config);
13
14    let basin: BasinName = "my-favorite-basin".parse()?;
15
16    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
17        // Set the default retention age to 10 days.
18        Duration::from_secs(10 * 24 * 60 * 60),
19    ));
20
21    let basin_config = BasinConfig::new()
22        .with_default_stream_config(default_stream_config)
23        .with_create_stream_on_append(false)
24        .with_create_stream_on_read(false);
25
26    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);
27
28    let created_basin = client.create_basin(create_basin_request).await?;
29    println!("{created_basin:#?}");
30
31    let basin_config = client.get_basin_config(basin).await?;
32    println!("{basin_config:#?}");
33
34    Ok(())
35}

More examples

Hide additional examples

examples/reconfigure_basin.rs (line 18)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let basin: BasinName = "my-favorite-basin".parse()?;
13
14    let default_stream_config_updates =
15        StreamConfig::new().with_storage_class(StorageClass::Standard);
16    let basin_config_updates = BasinConfig::new()
17        .with_default_stream_config(default_stream_config_updates)
18        .with_create_stream_on_append(true)
19        .with_create_stream_on_read(true);
20
21    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
22        .with_config(basin_config_updates)
23        // Field mask specifies which fields to update.
24        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);
25
26    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;
27
28    println!("{updated_basin_config:#?}");
29
30    Ok(())
31}

Source

pub fn with_create_stream_on_read(self, create_stream_on_read: bool) -> Self

Overwrite create_stream_on_read.

Examples found in repository ?

examples/create_basin.rs (line 24)

9async fn main() -> Result<(), Box<dyn std::error::Error>> {
10    let token = std::env::var("S2_ACCESS_TOKEN")?;
11    let config = ClientConfig::new(token);
12    let client = Client::new(config);
13
14    let basin: BasinName = "my-favorite-basin".parse()?;
15
16    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
17        // Set the default retention age to 10 days.
18        Duration::from_secs(10 * 24 * 60 * 60),
19    ));
20
21    let basin_config = BasinConfig::new()
22        .with_default_stream_config(default_stream_config)
23        .with_create_stream_on_append(false)
24        .with_create_stream_on_read(false);
25
26    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);
27
28    let created_basin = client.create_basin(create_basin_request).await?;
29    println!("{created_basin:#?}");
30
31    let basin_config = client.get_basin_config(basin).await?;
32    println!("{basin_config:#?}");
33
34    Ok(())
35}

More examples

Hide additional examples

examples/reconfigure_basin.rs (line 19)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let basin: BasinName = "my-favorite-basin".parse()?;
13
14    let default_stream_config_updates =
15        StreamConfig::new().with_storage_class(StorageClass::Standard);
16    let basin_config_updates = BasinConfig::new()
17        .with_default_stream_config(default_stream_config_updates)
18        .with_create_stream_on_append(true)
19        .with_create_stream_on_read(true);
20
21    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
22        .with_config(basin_config_updates)
23        // Field mask specifies which fields to update.
24        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);
25
26    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;
27
28    println!("{updated_basin_config:#?}");
29
30    Ok(())
31}