Struct GetUsageTopAvgMetricsOptionalParams

#[non_exhaustive]
pub struct GetUsageTopAvgMetricsOptionalParams {
    pub month: Option<DateTime<Utc>>,
    pub day: Option<DateTime<Utc>>,
    pub names: Option<Vec<String>>,
    pub limit: Option<i32>,
    pub next_record_id: Option<String>,
}

GetUsageTopAvgMetricsOptionalParams is a struct for passing parameters to the method UsageMeteringAPI::get_usage_top_avg_metrics

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.

month: Option<DateTime<Utc>>

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)

day: Option<DateTime<Utc>>

Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)

names: Option<Vec<String>>

Comma-separated list of metric names.

limit: Option<i32>

Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.

next_record_id: Option<String>

List following results with a next_record_id provided in the previous query.

Implementations

impl GetUsageTopAvgMetricsOptionalParams

pub fn month(self, value: DateTime<Utc>) -> Self

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both)

pub fn day(self, value: DateTime<Utc>) -> Self

Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both)

Examples found in repository

examples/v1_usage-metering_GetUsageTopAvgMetrics.rs (lines 13-17)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = UsageMeteringAPI::with_config(configuration);
    let resp = api
        .get_usage_top_avg_metrics(
            GetUsageTopAvgMetricsOptionalParams::default().day(
                DateTime::parse_from_rfc3339("2021-11-08T11:11:11+00:00")
                    .expect("Failed to parse datetime")
                    .with_timezone(&Utc),
            ),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn names(self, value: Vec<String>) -> Self

Comma-separated list of metric names.

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

Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.

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

List following results with a next_record_id provided in the previous query.

Trait Implementations

impl Clone for GetUsageTopAvgMetricsOptionalParams

fn clone(&self) -> GetUsageTopAvgMetricsOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetUsageTopAvgMetricsOptionalParams

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

Formats the value using the given formatter.

impl Default for GetUsageTopAvgMetricsOptionalParams

fn default() -> GetUsageTopAvgMetricsOptionalParams

Returns the “default value” for a type.