Struct GetStreamMetricsInput 

#[non_exhaustive]
pub struct GetStreamMetricsInput {
    pub basin_name: BasinName,
    pub stream_name: StreamName,
    pub set: StreamMetricSet,
}

Input for get_stream_metrics 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.

basin_name: BasinName

Basin name.

stream_name: StreamName

Stream name.

set: StreamMetricSet

Metric set to return.

Implementations

impl GetStreamMetricsInput

pub fn new( basin_name: BasinName, stream_name: StreamName, set: StreamMetricSet, ) -> Self

Create a new GetStreamMetricsInput with the given basin name, stream name and metric set.

Examples found in repository

examples/docs_metrics.rs (lines 43-47)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token = std::env::var("S2_ACCESS_TOKEN")?;
    let client = S2::new(S2Config::new(access_token))?;

    // ANCHOR: metrics
    let now = std::time::SystemTime::now()
        .duration_since(std::time::UNIX_EPOCH)?
        .as_secs() as u32;
    let thirty_days_ago = now - 30 * 24 * 3600;
    let six_hours_ago = now - 6 * 3600;
    let hour_ago = now - 3600;

    // Account-level: active basins over the last 30 days
    let account_metrics = client
        .get_account_metrics(GetAccountMetricsInput::new(AccountMetricSet::ActiveBasins(
            TimeRange::new(thirty_days_ago, now),
        )))
        .await?;

    // Basin-level: storage usage with hourly resolution
    let basin_metrics = client
        .get_basin_metrics(GetBasinMetricsInput::new(
            "events".parse()?,
            BasinMetricSet::Storage(TimeRange::new(six_hours_ago, now)),
        ))
        .await?;

    // Stream-level: storage for a specific stream
    let stream_metrics = client
        .get_stream_metrics(GetStreamMetricsInput::new(
            "events".parse()?,
            "user-actions".parse()?,
            StreamMetricSet::Storage(TimeRange::new(hour_ago, now)),
        ))
        .await?;
    // ANCHOR_END: metrics

    println!(
        "{:?} {:?} {:?}",
        account_metrics, basin_metrics, stream_metrics
    );

    Ok(())
}

Trait Implementations

impl Clone for GetStreamMetricsInput

fn clone(&self) -> GetStreamMetricsInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetStreamMetricsInput

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

Formats the value using the given formatter.

impl From<GetStreamMetricsInput> for (BasinName, StreamName, StreamMetricSetRequest)

fn from(value: GetStreamMetricsInput) -> Self

Converts to this type from the input type.