Struct Client 

pub struct Client { /* private fields */ }

Client for account-level operations.

Implementations

impl Client

pub fn new(config: ClientConfig) -> Self

Create a new SDK client.

Examples found in repository

examples/delete_basin.rs (line 10)

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

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

    let delete_basin_request = DeleteBasinRequest::new(basin)
        // Don't error if the basin doesn't exist.
        .with_if_exists(true);

    client.delete_basin(delete_basin_request).await?;

    Ok(())
}

examples/create_stream.rs (line 10)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_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(())
}

examples/list_all_basins.rs (line 10)

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

    let mut all_basins = Vec::new();

    let mut has_more = true;
    let mut start_after: Option<String> = None;

    while has_more {
        let mut list_basins_request = ListBasinsRequest::new();
        if let Some(start_after) = start_after.take() {
            list_basins_request = list_basins_request.with_start_after(start_after);
        }

        let list_basins_response = client.list_basins(list_basins_request).await?;

        all_basins.extend(list_basins_response.basins);

        start_after = all_basins.last().map(|b| b.name.clone());
        has_more = list_basins_response.has_more;
    }

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

    Ok(())
}

examples/issue_access_token.rs (line 13)

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

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

examples/create_basin.rs (line 12)

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

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

    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Set the default retention age to 10 days.
        Duration::from_secs(10 * 24 * 60 * 60),
    ));

    let basin_config = BasinConfig::new()
        .with_default_stream_config(default_stream_config)
        .with_create_stream_on_append(false)
        .with_create_stream_on_read(false);

    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);

    let created_basin = client.create_basin(create_basin_request).await?;
    println!("{created_basin:#?}");

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

    Ok(())
}

examples/reconfigure_basin.rs (line 10)

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

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

    let default_stream_config_updates =
        StreamConfig::new().with_storage_class(StorageClass::Standard);
    let basin_config_updates = BasinConfig::new()
        .with_default_stream_config(default_stream_config_updates)
        .with_create_stream_on_append(true)
        .with_create_stream_on_read(true);

    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
        .with_config(basin_config_updates)
        // Field mask specifies which fields to update.
        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);

    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;

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

    Ok(())
}

pub fn new_with_connector<C>(config: ClientConfig, 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 SDK client using a custom connector.

pub fn basin_client(&self, basin: BasinName) -> BasinClient

Create basin client from the given name.

Examples found in repository

examples/create_stream.rs (line 13)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_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_basins( &self, req: ListBasinsRequest, ) -> Result<ListBasinsResponse, ClientError>

List basins.

Examples found in repository

examples/list_all_basins.rs (line 23)

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

    let mut all_basins = Vec::new();

    let mut has_more = true;
    let mut start_after: Option<String> = None;

    while has_more {
        let mut list_basins_request = ListBasinsRequest::new();
        if let Some(start_after) = start_after.take() {
            list_basins_request = list_basins_request.with_start_after(start_after);
        }

        let list_basins_response = client.list_basins(list_basins_request).await?;

        all_basins.extend(list_basins_response.basins);

        start_after = all_basins.last().map(|b| b.name.clone());
        has_more = list_basins_response.has_more;
    }

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

    Ok(())
}

pub async fn create_basin( &self, req: CreateBasinRequest, ) -> Result<BasinInfo, ClientError>

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

Examples found in repository

examples/create_basin.rs (line 28)

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

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

    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Set the default retention age to 10 days.
        Duration::from_secs(10 * 24 * 60 * 60),
    ));

    let basin_config = BasinConfig::new()
        .with_default_stream_config(default_stream_config)
        .with_create_stream_on_append(false)
        .with_create_stream_on_read(false);

    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);

    let created_basin = client.create_basin(create_basin_request).await?;
    println!("{created_basin:#?}");

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

    Ok(())
}

pub async fn delete_basin( &self, req: DeleteBasinRequest, ) -> Result<(), ClientError>

Delete a basin. Basin deletion is asynchronous, and may take a few minutes to complete.

Examples found in repository

examples/delete_basin.rs (line 18)

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

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

    let delete_basin_request = DeleteBasinRequest::new(basin)
        // Don't error if the basin doesn't exist.
        .with_if_exists(true);

    client.delete_basin(delete_basin_request).await?;

    Ok(())
}

pub async fn get_basin_config( &self, basin: BasinName, ) -> Result<BasinConfig, ClientError>

Get basin configuration.

Examples found in repository

examples/create_basin.rs (line 31)

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

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

    let default_stream_config = StreamConfig::new().with_retention_policy(RetentionPolicy::Age(
        // Set the default retention age to 10 days.
        Duration::from_secs(10 * 24 * 60 * 60),
    ));

    let basin_config = BasinConfig::new()
        .with_default_stream_config(default_stream_config)
        .with_create_stream_on_append(false)
        .with_create_stream_on_read(false);

    let create_basin_request = CreateBasinRequest::new(basin.clone()).with_config(basin_config);

    let created_basin = client.create_basin(create_basin_request).await?;
    println!("{created_basin:#?}");

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

    Ok(())
}

pub async fn reconfigure_basin( &self, req: ReconfigureBasinRequest, ) -> Result<BasinConfig, ClientError>

Update basin configuration.

Examples found in repository

examples/reconfigure_basin.rs (line 26)

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

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

    let default_stream_config_updates =
        StreamConfig::new().with_storage_class(StorageClass::Standard);
    let basin_config_updates = BasinConfig::new()
        .with_default_stream_config(default_stream_config_updates)
        .with_create_stream_on_append(true)
        .with_create_stream_on_read(true);

    let reconfigure_basin_request = ReconfigureBasinRequest::new(basin)
        .with_config(basin_config_updates)
        // Field mask specifies which fields to update.
        .with_mask(vec!["default_stream_config.retention_policy".to_string()]);

    let updated_basin_config = client.reconfigure_basin(reconfigure_basin_request).await?;

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

    Ok(())
}

pub async fn issue_access_token( &self, info: AccessTokenInfo, ) -> Result<String, ClientError>

Issue a new access token.

Examples found in repository

examples/issue_access_token.rs (line 26)

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

    let access_token_id: AccessTokenId = "my-access-token".parse()?;
    let access_token_info = AccessTokenInfo::new(access_token_id).with_scope(
        AccessTokenScope::new()
            .with_op_groups(
                PermittedOperationGroups::new()
                    .with_account(ReadWritePermissions::new().with_read(true)),
            )
            .with_op(Operation::CreateStream)
            .with_streams(ResourceSet::Prefix("my-stream-prefix".to_string()))
            .with_basins(ResourceSet::Exact("my-perfect-basin".to_string())),
    );
    let token = client.issue_access_token(access_token_info).await?;

    println!("Access token: {token}");

    Ok(())
}

pub async fn revoke_access_token( &self, id: AccessTokenId, ) -> Result<AccessTokenInfo, ClientError>

Revoke an access token.

pub async fn list_access_tokens( &self, req: ListAccessTokensRequest, ) -> Result<ListAccessTokensResponse, ClientError>

List access tokens.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.