Struct SplitConfig

#[non_exhaustive]
pub struct SplitConfig {
    pub limit: i64,
    pub sort: SplitSort,
    pub split_dimensions: Vec<SplitDimension>,
    pub static_splits: Option<Vec<Vec<SplitVectorEntryItem>>>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

Encapsulates all user choices about how to split a graph.

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.

limit: i64

Maximum number of graphs to display in the widget.

sort: SplitSort

Controls the order in which graphs appear in the split.

split_dimensions: Vec<SplitDimension>

The dimension(s) on which to split the graph

static_splits: Option<Vec<Vec<SplitVectorEntryItem>>>

Manual selection of tags making split graph widget static

additional_properties: BTreeMap<String, Value>

Implementations

impl SplitConfig

pub fn new( limit: i64, sort: SplitSort, split_dimensions: Vec<SplitDimension>, ) -> SplitConfig

Examples found in repository

examples/v1_dashboards_CreateDashboard_2278756614.rs (lines 79-87)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::SplitGraphWidgetDefinition(
                        Box::new(
                            SplitGraphWidgetDefinition::new(
                                SplitGraphVizSize::MD,
                                SplitGraphSourceWidgetDefinition::TimeseriesWidgetDefinition(
                                    Box::new(
                                        TimeseriesWidgetDefinition::new(
                                            vec![
                                                TimeseriesWidgetRequest::new()
                                                    .display_type(WidgetDisplayType::LINE)
                                                    .queries(
                                                        vec![
                                                            FormulaAndFunctionQueryDefinition
                                                            ::FormulaAndFunctionMetricQueryDefinition(
                                                                Box::new(
                                                                    FormulaAndFunctionMetricQueryDefinition::new(
                                                                        FormulaAndFunctionMetricDataSource::METRICS,
                                                                        "query1".to_string(),
                                                                        "avg:system.cpu.user{*}".to_string(),
                                                                    ),
                                                                ),
                                                            )
                                                        ],
                                                    )
                                                    .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                                    .style(
                                                        WidgetRequestStyle::new()
                                                            .line_type(WidgetLineType::SOLID)
                                                            .line_width(WidgetLineWidth::NORMAL)
                                                            .palette("dog_classic".to_string()),
                                                    )
                                            ],
                                            TimeseriesWidgetDefinitionType::TIMESERIES,
                                        )
                                            .title("".to_string())
                                            .title_align(WidgetTextAlign::LEFT)
                                            .title_size("16".to_string()),
                                    ),
                                ),
                                SplitConfig::new(
                                    24,
                                    SplitSort::new(
                                        WidgetSort::DESCENDING,
                                    ).compute(
                                        SplitConfigSortCompute::new("sum".to_string(), "system.cpu.user".to_string()),
                                    ),
                                    vec![SplitDimension::new("service".to_string())],
                                ).static_splits(
                                    vec![
                                        vec![
                                            SplitVectorEntryItem::new(
                                                "service".to_string(),
                                                vec!["cassandra".to_string()],
                                            ),
                                            SplitVectorEntryItem::new("datacenter".to_string(), vec![])
                                        ],
                                        vec![SplitVectorEntryItem::new("demo".to_string(), vec!["env".to_string()])]
                                    ],
                                ),
                                SplitGraphWidgetDefinitionType::SPLIT_GROUP,
                            )
                                .has_uniform_y_axes(true)
                                .title("".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(8, 12, 0, 0))
            ],
        )
            .description(Some("".to_string()))
            .notify_list(Some(vec![]))
            .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 static_splits(self, value: Vec<Vec<SplitVectorEntryItem>>) -> Self

Examples found in repository

examples/v1_dashboards_CreateDashboard_2278756614.rs (lines 87-98)

async fn main() {
    let body =
        Dashboard::new(
            DashboardLayoutType::ORDERED,
            "Example-Dashboard".to_string(),
            vec![
                Widget::new(
                    WidgetDefinition::SplitGraphWidgetDefinition(
                        Box::new(
                            SplitGraphWidgetDefinition::new(
                                SplitGraphVizSize::MD,
                                SplitGraphSourceWidgetDefinition::TimeseriesWidgetDefinition(
                                    Box::new(
                                        TimeseriesWidgetDefinition::new(
                                            vec![
                                                TimeseriesWidgetRequest::new()
                                                    .display_type(WidgetDisplayType::LINE)
                                                    .queries(
                                                        vec![
                                                            FormulaAndFunctionQueryDefinition
                                                            ::FormulaAndFunctionMetricQueryDefinition(
                                                                Box::new(
                                                                    FormulaAndFunctionMetricQueryDefinition::new(
                                                                        FormulaAndFunctionMetricDataSource::METRICS,
                                                                        "query1".to_string(),
                                                                        "avg:system.cpu.user{*}".to_string(),
                                                                    ),
                                                                ),
                                                            )
                                                        ],
                                                    )
                                                    .response_format(FormulaAndFunctionResponseFormat::TIMESERIES)
                                                    .style(
                                                        WidgetRequestStyle::new()
                                                            .line_type(WidgetLineType::SOLID)
                                                            .line_width(WidgetLineWidth::NORMAL)
                                                            .palette("dog_classic".to_string()),
                                                    )
                                            ],
                                            TimeseriesWidgetDefinitionType::TIMESERIES,
                                        )
                                            .title("".to_string())
                                            .title_align(WidgetTextAlign::LEFT)
                                            .title_size("16".to_string()),
                                    ),
                                ),
                                SplitConfig::new(
                                    24,
                                    SplitSort::new(
                                        WidgetSort::DESCENDING,
                                    ).compute(
                                        SplitConfigSortCompute::new("sum".to_string(), "system.cpu.user".to_string()),
                                    ),
                                    vec![SplitDimension::new("service".to_string())],
                                ).static_splits(
                                    vec![
                                        vec![
                                            SplitVectorEntryItem::new(
                                                "service".to_string(),
                                                vec!["cassandra".to_string()],
                                            ),
                                            SplitVectorEntryItem::new("datacenter".to_string(), vec![])
                                        ],
                                        vec![SplitVectorEntryItem::new("demo".to_string(), vec!["env".to_string()])]
                                    ],
                                ),
                                SplitGraphWidgetDefinitionType::SPLIT_GROUP,
                            )
                                .has_uniform_y_axes(true)
                                .title("".to_string()),
                        ),
                    ),
                ).layout(WidgetLayout::new(8, 12, 0, 0))
            ],
        )
            .description(Some("".to_string()))
            .notify_list(Some(vec![]))
            .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 SplitConfig

fn clone(&self) -> SplitConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SplitConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SplitConfig

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

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 SplitConfig