Struct ReconfigureStreamRequest

pub struct ReconfigureStreamRequest {
    pub stream: String,
    pub config: Option<StreamConfig>,
    pub mask: Option<Vec<String>>,
}

Reconfigure stream request.

Fields

stream: String

Stream name.

config: Option<StreamConfig>

Stream configuration with updated values.

mask: Option<Vec<String>>

Specifies the pieces of configuration being updated. See https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask

Implementations

impl ReconfigureStreamRequest

pub fn new(stream: impl Into<String>) -> Self

Create a new request with stream name.

Examples found in repository

examples/reconfigure_stream.rs (line 22)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_TOKEN")?;
    let config = ClientConfig::new(token);
    let basin: BasinName = "my-favorite-basin".parse()?;
    let basin_client = BasinClient::new(config, basin);

    let stream = "my-favorite-stream";

    let stream_config_updates = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Change to retention policy to 1 day
        Duration::from_secs(24 * 60 * 60),
    ));

    let reconfigure_stream_request = ReconfigureStreamRequest::new(stream)
        .with_config(stream_config_updates)
        // Field mask specifies which fields to update.
        .with_mask(vec!["retention_policy".to_string()]);

    let updated_stream_config = basin_client
        .reconfigure_stream(reconfigure_stream_request)
        .await?;

    println!("{updated_stream_config:#?}");

    Ok(())
}

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

Overwrite stream config.

Examples found in repository

examples/reconfigure_stream.rs (line 23)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_TOKEN")?;
    let config = ClientConfig::new(token);
    let basin: BasinName = "my-favorite-basin".parse()?;
    let basin_client = BasinClient::new(config, basin);

    let stream = "my-favorite-stream";

    let stream_config_updates = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Change to retention policy to 1 day
        Duration::from_secs(24 * 60 * 60),
    ));

    let reconfigure_stream_request = ReconfigureStreamRequest::new(stream)
        .with_config(stream_config_updates)
        // Field mask specifies which fields to update.
        .with_mask(vec!["retention_policy".to_string()]);

    let updated_stream_config = basin_client
        .reconfigure_stream(reconfigure_stream_request)
        .await?;

    println!("{updated_stream_config:#?}");

    Ok(())
}

pub fn with_mask(self, mask: impl Into<Vec<String>>) -> Self

Overwrite field mask.

Examples found in repository

examples/reconfigure_stream.rs (line 25)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_TOKEN")?;
    let config = ClientConfig::new(token);
    let basin: BasinName = "my-favorite-basin".parse()?;
    let basin_client = BasinClient::new(config, basin);

    let stream = "my-favorite-stream";

    let stream_config_updates = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Change to retention policy to 1 day
        Duration::from_secs(24 * 60 * 60),
    ));

    let reconfigure_stream_request = ReconfigureStreamRequest::new(stream)
        .with_config(stream_config_updates)
        // Field mask specifies which fields to update.
        .with_mask(vec!["retention_policy".to_string()]);

    let updated_stream_config = basin_client
        .reconfigure_stream(reconfigure_stream_request)
        .await?;

    println!("{updated_stream_config:#?}");

    Ok(())
}

Trait Implementations

impl Clone for ReconfigureStreamRequest

fn clone(&self) -> ReconfigureStreamRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReconfigureStreamRequest

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

Formats the value using the given formatter.