Struct BasinClient

pub struct BasinClient { /* private fields */ }

Client for basin-level operations.

Implementations

impl BasinClient

pub fn new(config: ClientConfig, basin: BasinName) -> Self

Create a new basin client.

Examples found in repository

examples/delete_stream.rs (line 11)

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 delete_stream_request = DeleteStreamRequest::new(stream);

    basin_client.delete_stream(delete_stream_request).await?;

    Ok(())
}

examples/list_streams.rs (line 11)

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 prefix = "my-";
    let list_streams_request = ListStreamsRequest::new().with_prefix(prefix);

    let list_streams_response = basin_client.list_streams(list_streams_request).await?;

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

    Ok(())
}

examples/reconfigure_stream.rs (line 13)

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 new_with_connector<C>( config: ClientConfig, basin: BasinName, connector: C, ) -> Self

where C: Service<Uri> + Send + 'static, C::Response: Read + Write + Send + Unpin, C::Future: Send, C::Error: Error + Send + Sync + 'static,

Create a new basin client using a custom connector.

pub fn stream_client(&self, stream: impl Into<String>) -> StreamClient

Create a new client for stream-level operations.

pub async fn create_stream( &self, req: CreateStreamRequest, ) -> Result<StreamInfo, ClientError>

Create a stream. Provide a client request token with the S2-Request-Token header for idempotent retry behaviour.

Examples found in repository

examples/create_stream.rs (line 21)

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

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

    let stream = "my-favorite-stream";

    let stream_config = StreamConfig::new().with_storage_class(StorageClass::Express);

    let create_stream_request = CreateStreamRequest::new(stream).with_config(stream_config);

    let created_stream = basin_client.create_stream(create_stream_request).await?;
    println!("{created_stream:#?}");

    let stream_config = basin_client.get_stream_config(stream).await?;
    println!("{stream_config:#?}");

    Ok(())
}

pub async fn list_streams( &self, req: ListStreamsRequest, ) -> Result<ListStreamsResponse, ClientError>

List streams.

Examples found in repository

examples/list_streams.rs (line 16)

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 prefix = "my-";
    let list_streams_request = ListStreamsRequest::new().with_prefix(prefix);

    let list_streams_response = basin_client.list_streams(list_streams_request).await?;

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

    Ok(())
}

pub async fn get_stream_config( &self, stream: impl Into<String>, ) -> Result<StreamConfig, ClientError>

Get stream configuration.

Examples found in repository

examples/create_stream.rs (line 24)

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

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

    let stream = "my-favorite-stream";

    let stream_config = StreamConfig::new().with_storage_class(StorageClass::Express);

    let create_stream_request = CreateStreamRequest::new(stream).with_config(stream_config);

    let created_stream = basin_client.create_stream(create_stream_request).await?;
    println!("{created_stream:#?}");

    let stream_config = basin_client.get_stream_config(stream).await?;
    println!("{stream_config:#?}");

    Ok(())
}

pub async fn reconfigure_stream( &self, req: ReconfigureStreamRequest, ) -> Result<StreamConfig, ClientError>

Update stream configuration.

Examples found in repository

examples/reconfigure_stream.rs (line 28)

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 async fn delete_stream( &self, req: DeleteStreamRequest, ) -> Result<(), ClientError>

Delete a stream. Stream deletion is asynchronous, and may take a few minutes to complete.

Examples found in repository

examples/delete_stream.rs (line 17)

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 delete_stream_request = DeleteStreamRequest::new(stream);

    basin_client.delete_stream(delete_stream_request).await?;

    Ok(())
}

Trait Implementations

impl Clone for BasinClient

fn clone(&self) -> BasinClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasinClient

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

Formats the value using the given formatter.