Struct datadog_api_client::datadogV1::api::api_snapshots::GetGraphSnapshotOptionalParams

#[non_exhaustive]
pub struct GetGraphSnapshotOptionalParams {
    pub metric_query: Option<String>,
    pub event_query: Option<String>,
    pub graph_def: Option<String>,
    pub title: Option<String>,
    pub height: Option<i64>,
    pub width: Option<i64>,
}

GetGraphSnapshotOptionalParams is a struct for passing parameters to the method SnapshotsAPI::get_graph_snapshot

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.

metric_query: Option<String>

The metric query.

event_query: Option<String>

A query that adds event bands to the graph.

graph_def: Option<String>

A JSON document defining the graph. graph_def can be used instead of metric_query. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded.

title: Option<String>

A title for the graph. If no title is specified, the graph does not have a title.

height: Option<i64>

The height of the graph. If no height is specified, the graph’s original height is used.

width: Option<i64>

The width of the graph. If no width is specified, the graph’s original width is used.

Implementations

impl GetGraphSnapshotOptionalParams

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

The metric query.

Examples found in repository

examples/v1_snapshots_GetGraphSnapshot.rs (line 15)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = SnapshotsAPI::with_config(configuration);
    let resp = api
        .get_graph_snapshot(
            1636542671,
            1636629071,
            GetGraphSnapshotOptionalParams::default()
                .metric_query("avg:system.load.1{*}".to_string())
                .title("System load".to_string())
                .height(400)
                .width(600),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

A query that adds event bands to the graph.

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

A JSON document defining the graph. graph_def can be used instead of metric_query. The JSON document uses the grammar defined here and should be formatted to a single line then URL encoded.

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

A title for the graph. If no title is specified, the graph does not have a title.

Examples found in repository

examples/v1_snapshots_GetGraphSnapshot.rs (line 16)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = SnapshotsAPI::with_config(configuration);
    let resp = api
        .get_graph_snapshot(
            1636542671,
            1636629071,
            GetGraphSnapshotOptionalParams::default()
                .metric_query("avg:system.load.1{*}".to_string())
                .title("System load".to_string())
                .height(400)
                .width(600),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn height(self, value: i64) -> Self

The height of the graph. If no height is specified, the graph’s original height is used.

Examples found in repository

examples/v1_snapshots_GetGraphSnapshot.rs (line 17)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = SnapshotsAPI::with_config(configuration);
    let resp = api
        .get_graph_snapshot(
            1636542671,
            1636629071,
            GetGraphSnapshotOptionalParams::default()
                .metric_query("avg:system.load.1{*}".to_string())
                .title("System load".to_string())
                .height(400)
                .width(600),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn width(self, value: i64) -> Self

The width of the graph. If no width is specified, the graph’s original width is used.

Examples found in repository

examples/v1_snapshots_GetGraphSnapshot.rs (line 18)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = SnapshotsAPI::with_config(configuration);
    let resp = api
        .get_graph_snapshot(
            1636542671,
            1636629071,
            GetGraphSnapshotOptionalParams::default()
                .metric_query("avg:system.load.1{*}".to_string())
                .title("System load".to_string())
                .height(400)
                .width(600),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Trait Implementations

impl Clone for GetGraphSnapshotOptionalParams

fn clone(&self) -> GetGraphSnapshotOptionalParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetGraphSnapshotOptionalParams

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

Formats the value using the given formatter.

impl Default for GetGraphSnapshotOptionalParams

fn default() -> GetGraphSnapshotOptionalParams

Returns the “default value” for a type.