Struct ListMonitorsOptionalParams

#[non_exhaustive]
pub struct ListMonitorsOptionalParams {
    pub group_states: Option<String>,
    pub name: Option<String>,
    pub tags: Option<String>,
    pub monitor_tags: Option<String>,
    pub with_downtimes: Option<bool>,
    pub id_offset: Option<i64>,
    pub page: Option<i64>,
    pub page_size: Option<i32>,
}

ListMonitorsOptionalParams is a struct for passing parameters to the method MonitorsAPI::list_monitors

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.

group_states: Option<String>

When specified, shows additional information about the group states. Choose one or more from all, alert, warn, and no data.

name: Option<String>

A string to filter monitors by name.

tags: Option<String>

A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, host:host0.

monitor_tags: Option<String>

A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, service:my-app.

with_downtimes: Option<bool>

If this argument is set to true, then the returned data includes all current active downtimes for each monitor.

id_offset: Option<i64>

Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty.

page: Option<i64>

The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.

page_size: Option<i32>

The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a page_size limit. However, if page is specified and page_size is not, the argument defaults to 100.

Implementations

impl ListMonitorsOptionalParams

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

When specified, shows additional information about the group states. Choose one or more from all, alert, warn, and no data.

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

A string to filter monitors by name.

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

A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, host:host0.

Examples found in repository

examples/v1_monitors_ListMonitors_2154432960.rs (line 13)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = MonitorsAPI::with_config(configuration);
    let resp = api
        .list_monitors(
            ListMonitorsOptionalParams::default()
                .tags("test:examplemonitor".to_string())
                .page_size(1),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, service:my-app.

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

If this argument is set to true, then the returned data includes all current active downtimes for each monitor.

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

Use this parameter for paginating through large sets of monitors. Start with a value of zero, make a request, set the value to the last ID of result set, and then repeat until the response is empty.

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

The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination.

pub fn page_size(self, value: i32) -> Self

The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a page_size limit. However, if page is specified and page_size is not, the argument defaults to 100.

Examples found in repository

examples/v1_monitors_ListMonitors_2154432960.rs (line 14)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = MonitorsAPI::with_config(configuration);
    let resp = api
        .list_monitors(
            ListMonitorsOptionalParams::default()
                .tags("test:examplemonitor".to_string())
                .page_size(1),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_monitors_ListMonitors_463213563.rs (line 13)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = MonitorsAPI::with_config(configuration);
    let response =
        api.list_monitors_with_pagination(ListMonitorsOptionalParams::default().page_size(2));
    pin_mut!(response);
    while let Some(resp) = response.next().await {
        if let Ok(value) = resp {
            println!("{:#?}", value);
        } else {
            println!("{:#?}", resp.unwrap_err());
        }
    }
}

Trait Implementations

impl Clone for ListMonitorsOptionalParams

fn clone(&self) -> ListMonitorsOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListMonitorsOptionalParams

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

Formats the value using the given formatter.

impl Default for ListMonitorsOptionalParams

fn default() -> ListMonitorsOptionalParams

Returns the “default value” for a type.