Struct WidgetNumberFormat

#[non_exhaustive]
pub struct WidgetNumberFormat {
    pub unit: Option<NumberFormatUnit>,
    pub unit_scale: Option<Option<NumberFormatUnitScale>>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

Number format options for the widget.

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.

unit: Option<NumberFormatUnit>

Number format unit.

unit_scale: Option<Option<NumberFormatUnitScale>>

The definition of NumberFormatUnitScale object.

additional_properties: BTreeMap<String, Value>

Implementations

impl WidgetNumberFormat

pub fn new() -> WidgetNumberFormat

Examples found in repository

examples/v1_dashboards_CreateDashboard_3520534424.rs (line 48)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TimeseriesWidgetDefinition(
                        Box::new(
                            TimeseriesWidgetDefinition::new(
                                vec![
                                    TimeseriesWidgetRequest::new()
                                        .display_type(WidgetDisplayType::LINE)
                                        .formulas(
                                            vec![
                                                WidgetFormula::new(
                                                    "query1".to_string(),
                                                ).number_format(
                                                    WidgetNumberFormat::new()
                                                        .unit(
                                                            NumberFormatUnit::NumberFormatUnitCanonical(
                                                                Box::new(
                                                                    NumberFormatUnitCanonical::new()
                                                                        .type_(
                                                                            NumberFormatUnitScaleType::CANONICAL_UNIT,
                                                                        )
                                                                        .unit_name("fraction".to_string()),
                                                                ),
                                                            ),
                                                        )
                                                        .unit_scale(
                                                            Some(
                                                                NumberFormatUnitScale::new()
                                                                    .type_(NumberFormatUnitScaleType::CANONICAL_UNIT)
                                                                    .unit_name("apdex".to_string()),
                                                            ),
                                                        ),
                                                )
                                            ],
                                        )
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionMetricQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionMetricQueryDefinition::new(
                                                            FormulaAndFunctionMetricDataSource::METRICS,
                                                            "query1".to_string(),
                                                            "avg:system.cpu.user{*}".to_string(),
                                                        ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                ],
                                TimeseriesWidgetDefinitionType::TIMESERIES,
                            )
                                .legend_layout(TimeseriesWidgetLegendLayout::AUTO)
                                .show_legend(true)
                                .time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new())))
                                .title("".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(5, 12, 0, 0))
            ],
        )
            .description(Some("".to_string()))
            .notify_list(Some(vec![]))
            .reflow_type(DashboardReflowType::FIXED)
            .template_variables(Some(vec![]));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn unit(self, value: NumberFormatUnit) -> Self

Examples found in repository

examples/v1_dashboards_CreateDashboard_3520534424.rs (lines 49-59)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TimeseriesWidgetDefinition(
                        Box::new(
                            TimeseriesWidgetDefinition::new(
                                vec![
                                    TimeseriesWidgetRequest::new()
                                        .display_type(WidgetDisplayType::LINE)
                                        .formulas(
                                            vec![
                                                WidgetFormula::new(
                                                    "query1".to_string(),
                                                ).number_format(
                                                    WidgetNumberFormat::new()
                                                        .unit(
                                                            NumberFormatUnit::NumberFormatUnitCanonical(
                                                                Box::new(
                                                                    NumberFormatUnitCanonical::new()
                                                                        .type_(
                                                                            NumberFormatUnitScaleType::CANONICAL_UNIT,
                                                                        )
                                                                        .unit_name("fraction".to_string()),
                                                                ),
                                                            ),
                                                        )
                                                        .unit_scale(
                                                            Some(
                                                                NumberFormatUnitScale::new()
                                                                    .type_(NumberFormatUnitScaleType::CANONICAL_UNIT)
                                                                    .unit_name("apdex".to_string()),
                                                            ),
                                                        ),
                                                )
                                            ],
                                        )
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionMetricQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionMetricQueryDefinition::new(
                                                            FormulaAndFunctionMetricDataSource::METRICS,
                                                            "query1".to_string(),
                                                            "avg:system.cpu.user{*}".to_string(),
                                                        ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                ],
                                TimeseriesWidgetDefinitionType::TIMESERIES,
                            )
                                .legend_layout(TimeseriesWidgetLegendLayout::AUTO)
                                .show_legend(true)
                                .time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new())))
                                .title("".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(5, 12, 0, 0))
            ],
        )
            .description(Some("".to_string()))
            .notify_list(Some(vec![]))
            .reflow_type(DashboardReflowType::FIXED)
            .template_variables(Some(vec![]));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn unit_scale(self, value: Option<NumberFormatUnitScale>) -> Self

Examples found in repository

examples/v1_dashboards_CreateDashboard_3520534424.rs (lines 60-66)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TimeseriesWidgetDefinition(
                        Box::new(
                            TimeseriesWidgetDefinition::new(
                                vec![
                                    TimeseriesWidgetRequest::new()
                                        .display_type(WidgetDisplayType::LINE)
                                        .formulas(
                                            vec![
                                                WidgetFormula::new(
                                                    "query1".to_string(),
                                                ).number_format(
                                                    WidgetNumberFormat::new()
                                                        .unit(
                                                            NumberFormatUnit::NumberFormatUnitCanonical(
                                                                Box::new(
                                                                    NumberFormatUnitCanonical::new()
                                                                        .type_(
                                                                            NumberFormatUnitScaleType::CANONICAL_UNIT,
                                                                        )
                                                                        .unit_name("fraction".to_string()),
                                                                ),
                                                            ),
                                                        )
                                                        .unit_scale(
                                                            Some(
                                                                NumberFormatUnitScale::new()
                                                                    .type_(NumberFormatUnitScaleType::CANONICAL_UNIT)
                                                                    .unit_name("apdex".to_string()),
                                                            ),
                                                        ),
                                                )
                                            ],
                                        )
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionMetricQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionMetricQueryDefinition::new(
                                                            FormulaAndFunctionMetricDataSource::METRICS,
                                                            "query1".to_string(),
                                                            "avg:system.cpu.user{*}".to_string(),
                                                        ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                ],
                                TimeseriesWidgetDefinitionType::TIMESERIES,
                            )
                                .legend_layout(TimeseriesWidgetLegendLayout::AUTO)
                                .show_legend(true)
                                .time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new())))
                                .title("".to_string())
                                .title_align(WidgetTextAlign::LEFT)
                                .title_size("16".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(5, 12, 0, 0))
            ],
        )
            .description(Some("".to_string()))
            .notify_list(Some(vec![]))
            .reflow_type(DashboardReflowType::FIXED)
            .template_variables(Some(vec![]));
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api.create_dashboard(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for WidgetNumberFormat

fn clone(&self) -> WidgetNumberFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetNumberFormat

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

Formats the value using the given formatter.

impl Default for WidgetNumberFormat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WidgetNumberFormat

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WidgetNumberFormat

fn eq(&self, other: &WidgetNumberFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WidgetNumberFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WidgetNumberFormat