Struct GetMonthlyUsageAttributionOptionalParams

#[non_exhaustive]
pub struct GetMonthlyUsageAttributionOptionalParams {
    pub end_month: Option<DateTime<Utc>>,
    pub sort_direction: Option<UsageSortDirection>,
    pub sort_name: Option<MonthlyUsageAttributionSupportedMetrics>,
    pub tag_breakdown_keys: Option<String>,
    pub next_record_id: Option<String>,
    pub include_descendants: Option<bool>,
}

GetMonthlyUsageAttributionOptionalParams is a struct for passing parameters to the method UsageMeteringAPI::get_monthly_usage_attribution

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.

end_month: Option<DateTime<Utc>>

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage ending this month.

sort_direction: Option<UsageSortDirection>

The direction to sort by: [desc, asc].

sort_name: Option<MonthlyUsageAttributionSupportedMetrics>

The field to sort by. The following values have been deprecated: estimated_indexed_spans_usage, estimated_indexed_spans_percentage, estimated_ingested_spans_usage, estimated_ingested_spans_percentage.

tag_breakdown_keys: Option<String>

Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.

To see which tags are available, look for the value of tag_config_source in the API response.

next_record_id: Option<String>

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

include_descendants: Option<bool>

Include child org usage in the response. Defaults to true.

Implementations

impl GetMonthlyUsageAttributionOptionalParams

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

Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage ending this month.

pub fn sort_direction(self, value: UsageSortDirection) -> Self

The direction to sort by: [desc, asc].

pub fn sort_name(self, value: MonthlyUsageAttributionSupportedMetrics) -> Self

The field to sort by. The following values have been deprecated: estimated_indexed_spans_usage, estimated_indexed_spans_percentage, estimated_ingested_spans_usage, estimated_ingested_spans_percentage.

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

Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.

To see which tags are available, look for the value of tag_config_source in the API response.

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

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

Examples found in repository

examples/v1_usage-metering_GetMonthlyUsageAttribution_3849653599.rs (lines 21-23)

async fn main() {
    // there is a valid "monthly_usage_attribution" response
    let monthly_usage_attribution_metadata_pagination_next_record_id =
        std::env::var("MONTHLY_USAGE_ATTRIBUTION_METADATA_PAGINATION_NEXT_RECORD_ID").unwrap();
    let configuration = datadog::Configuration::new();
    let api = UsageMeteringAPI::with_config(configuration);
    let resp = api
        .get_monthly_usage_attribution(
            DateTime::parse_from_rfc3339("2021-11-08T11:11:11+00:00")
                .expect("Failed to parse datetime")
                .with_timezone(&Utc),
            MonthlyUsageAttributionSupportedMetrics::INFRA_HOST_USAGE,
            GetMonthlyUsageAttributionOptionalParams::default().next_record_id(
                monthly_usage_attribution_metadata_pagination_next_record_id.clone(),
            ),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

Include child org usage in the response. Defaults to true.

Trait Implementations

impl Clone for GetMonthlyUsageAttributionOptionalParams

fn clone(&self) -> GetMonthlyUsageAttributionOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetMonthlyUsageAttributionOptionalParams

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

Formats the value using the given formatter.

impl Default for GetMonthlyUsageAttributionOptionalParams

fn default() -> GetMonthlyUsageAttributionOptionalParams

Returns the “default value” for a type.