Struct EstimateMetricsOutputSeriesOptionalParams

#[non_exhaustive]
pub struct EstimateMetricsOutputSeriesOptionalParams {
    pub filter_groups: Option<String>,
    pub filter_hours_ago: Option<i32>,
    pub filter_num_aggregations: Option<i32>,
    pub filter_pct: Option<bool>,
    pub filter_timespan_h: Option<i32>,
}

EstimateMetricsOutputSeriesOptionalParams is a struct for passing parameters to the method MetricsAPI::estimate_metrics_output_series

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.

filter_groups: Option<String>

Filtered tag keys that the metric is configured to query with.

filter_hours_ago: Option<i32>

The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.

filter_num_aggregations: Option<i32>

Deprecated. Number of aggregations has no impact on volume.

filter_pct: Option<bool>

A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.

filter_timespan_h: Option<i32>

A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.

Implementations

impl EstimateMetricsOutputSeriesOptionalParams

pub fn filter_groups(self, value: String) -> Self

Filtered tag keys that the metric is configured to query with.

Examples found in repository

examples/v2_metrics_EstimateMetricsOutputSeries.rs (line 14)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = MetricsAPI::with_config(configuration);
    let resp = api
        .estimate_metrics_output_series(
            "system.cpu.idle".to_string(),
            EstimateMetricsOutputSeriesOptionalParams::default()
                .filter_groups("app,host".to_string())
                .filter_num_aggregations(4),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn filter_hours_ago(self, value: i32) -> Self

The number of hours of look back (from now) to estimate cardinality with. If unspecified, it defaults to 0 hours.

pub fn filter_num_aggregations(self, value: i32) -> Self

Deprecated. Number of aggregations has no impact on volume.

Examples found in repository

examples/v2_metrics_EstimateMetricsOutputSeries.rs (line 15)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = MetricsAPI::with_config(configuration);
    let resp = api
        .estimate_metrics_output_series(
            "system.cpu.idle".to_string(),
            EstimateMetricsOutputSeriesOptionalParams::default()
                .filter_groups("app,host".to_string())
                .filter_num_aggregations(4),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn filter_pct(self, value: bool) -> Self

A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.

pub fn filter_timespan_h(self, value: i32) -> Self

A window, in hours, from the look back to estimate cardinality with. The minimum and default is 1 hour.

Trait Implementations

impl Clone for EstimateMetricsOutputSeriesOptionalParams

fn clone(&self) -> EstimateMetricsOutputSeriesOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EstimateMetricsOutputSeriesOptionalParams

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

Formats the value using the given formatter.

impl Default for EstimateMetricsOutputSeriesOptionalParams

fn default() -> EstimateMetricsOutputSeriesOptionalParams

Returns the “default value” for a type.