Struct ListDashboardsOptionalParams

#[non_exhaustive]
pub struct ListDashboardsOptionalParams {
    pub filter_shared: Option<bool>,
    pub filter_deleted: Option<bool>,
    pub count: Option<i64>,
    pub start: Option<i64>,
}

ListDashboardsOptionalParams is a struct for passing parameters to the method DashboardsAPI::list_dashboards

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.

filter_shared: Option<bool>

When true, this query only returns shared custom created or cloned dashboards.

filter_deleted: Option<bool>

When true, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with filter[shared].

count: Option<i64>

The maximum number of dashboards returned in the list.

start: Option<i64>

The specific offset to use as the beginning of the returned response.

Implementations

impl ListDashboardsOptionalParams

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

When true, this query only returns shared custom created or cloned dashboards.

Examples found in repository

examples/v1_dashboards_ListDashboards.rs (line 11)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .list_dashboards(ListDashboardsOptionalParams::default().filter_shared(false))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

When true, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with filter[shared].

Examples found in repository

examples/v1_dashboards_ListDashboards_1773932563.rs (line 11)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = DashboardsAPI::with_config(configuration);
    let resp = api
        .list_dashboards(ListDashboardsOptionalParams::default().filter_deleted(true))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

The maximum number of dashboards returned in the list.

Examples found in repository

examples/v1_dashboards_ListDashboards_1062671515.rs (line 13)

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

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

The specific offset to use as the beginning of the returned response.

Trait Implementations

impl Clone for ListDashboardsOptionalParams

fn clone(&self) -> ListDashboardsOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListDashboardsOptionalParams

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

Formats the value using the given formatter.

impl Default for ListDashboardsOptionalParams

fn default() -> ListDashboardsOptionalParams

Returns the “default value” for a type.