Struct datadog_api_client::datadogV1::model::model_tree_map_widget_definition::TreeMapWidgetDefinition

#[non_exhaustive]
pub struct TreeMapWidgetDefinition {
    pub color_by: Option<TreeMapColorBy>,
    pub custom_links: Option<Vec<WidgetCustomLink>>,
    pub group_by: Option<TreeMapGroupBy>,
    pub requests: Vec<TreeMapWidgetRequest>,
    pub size_by: Option<TreeMapSizeBy>,
    pub time: Option<WidgetTime>,
    pub title: Option<String>,
    pub type_: TreeMapWidgetDefinitionType,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.

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.

color_by: Option<TreeMapColorBy>

👎Deprecated

(deprecated) The attribute formerly used to determine color in the widget.

custom_links: Option<Vec<WidgetCustomLink>>

List of custom links.

group_by: Option<TreeMapGroupBy>

👎Deprecated

(deprecated) The attribute formerly used to group elements in the widget.

requests: Vec<TreeMapWidgetRequest>

List of treemap widget requests.

size_by: Option<TreeMapSizeBy>

👎Deprecated

(deprecated) The attribute formerly used to determine size in the widget.

time: Option<WidgetTime>

Time setting for the widget.

title: Option<String>

Title of your widget.

type_: TreeMapWidgetDefinitionType

Type of the treemap widget.

additional_properties: BTreeMap<String, Value>

Implementations

impl TreeMapWidgetDefinition

pub fn new( requests: Vec<TreeMapWidgetRequest>, type_: TreeMapWidgetDefinitionType, ) -> TreeMapWidgetDefinition

Examples found in repository

examples/v1_dashboards_CreateDashboard_1024858348.rs (lines 31-66)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TreeMapWidgetDefinition(
                        Box::new(
                            TreeMapWidgetDefinition::new(
                                vec![
                                    TreeMapWidgetRequest::new()
                                        .formulas(
                                            vec![
                                                WidgetFormula::new("hour_before(query1)".to_string()),
                                                WidgetFormula::new("query1".to_string())
                                            ],
                                        )
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionEventQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionEventQueryDefinition::new(
                                                            FormulaAndFunctionEventQueryDefinitionCompute::new(
                                                                FormulaAndFunctionEventAggregation::COUNT,
                                                            ),
                                                            FormulaAndFunctionEventsDataSource::LOGS,
                                                            "query1".to_string(),
                                                        )
                                                            .group_by(vec![])
                                                            .indexes(vec!["*".to_string()])
                                                            .search(
                                                                FormulaAndFunctionEventQueryDefinitionSearch::new(
                                                                    "".to_string(),
                                                                ),
                                                            ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::SCALAR)
                                ],
                                TreeMapWidgetDefinitionType::TREEMAP,
                            ).title("".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(4, 4, 0, 0))
            ],
        );
    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 color_by(self, value: TreeMapColorBy) -> Self

pub fn custom_links(self, value: Vec<WidgetCustomLink>) -> Self

pub fn group_by(self, value: TreeMapGroupBy) -> Self

pub fn size_by(self, value: TreeMapSizeBy) -> Self

pub fn time(self, value: WidgetTime) -> Self

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

Examples found in repository

examples/v1_dashboards_CreateDashboard_1024858348.rs (line 66)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::TreeMapWidgetDefinition(
                        Box::new(
                            TreeMapWidgetDefinition::new(
                                vec![
                                    TreeMapWidgetRequest::new()
                                        .formulas(
                                            vec![
                                                WidgetFormula::new("hour_before(query1)".to_string()),
                                                WidgetFormula::new("query1".to_string())
                                            ],
                                        )
                                        .queries(
                                            vec![
                                                FormulaAndFunctionQueryDefinition
                                                ::FormulaAndFunctionEventQueryDefinition(
                                                    Box::new(
                                                        FormulaAndFunctionEventQueryDefinition::new(
                                                            FormulaAndFunctionEventQueryDefinitionCompute::new(
                                                                FormulaAndFunctionEventAggregation::COUNT,
                                                            ),
                                                            FormulaAndFunctionEventsDataSource::LOGS,
                                                            "query1".to_string(),
                                                        )
                                                            .group_by(vec![])
                                                            .indexes(vec!["*".to_string()])
                                                            .search(
                                                                FormulaAndFunctionEventQueryDefinitionSearch::new(
                                                                    "".to_string(),
                                                                ),
                                                            ),
                                                    ),
                                                )
                                            ],
                                        )
                                        .response_format(FormulaAndFunctionResponseFormat::SCALAR)
                                ],
                                TreeMapWidgetDefinitionType::TREEMAP,
                            ).title("".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(4, 4, 0, 0))
            ],
        );
    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 TreeMapWidgetDefinition

fn clone(&self) -> TreeMapWidgetDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeMapWidgetDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TreeMapWidgetDefinition

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TreeMapWidgetDefinition

fn eq(&self, other: &TreeMapWidgetDefinition) -> 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 TreeMapWidgetDefinition

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 TreeMapWidgetDefinition