Struct datadog_api_client::datadogV1::api::api_hosts::ListHostsOptionalParams

#[non_exhaustive]
pub struct ListHostsOptionalParams {
    pub filter: Option<String>,
    pub sort_field: Option<String>,
    pub sort_dir: Option<String>,
    pub start: Option<i64>,
    pub count: Option<i64>,
    pub from: Option<i64>,
    pub include_muted_hosts_data: Option<bool>,
    pub include_hosts_metadata: Option<bool>,
}

ListHostsOptionalParams is a struct for passing parameters to the method HostsAPI::list_hosts

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: Option<String>

String to filter search results.

sort_field: Option<String>

Sort hosts by this field.

sort_dir: Option<String>

Direction of sort. Options include asc and desc.

start: Option<i64>

Specify the starting point for the host search results. For example, if you set count to 100 and the first 100 results have already been returned, you can set start to 101 to get the next 100 results.

count: Option<i64>

Number of hosts to return. Max 1000.

from: Option<i64>

Number of seconds since UNIX epoch from which you want to search your hosts.

include_muted_hosts_data: Option<bool>

Include information on the muted status of hosts and when the mute expires.

include_hosts_metadata: Option<bool>

Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).

Implementations

impl ListHostsOptionalParams

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

String to filter search results.

Examples found in repository

examples/v1_hosts_ListHosts.rs (line 11)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = HostsAPI::with_config(configuration);
    let resp = api
        .list_hosts(ListHostsOptionalParams::default().filter("env:ci".to_string()))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

Sort hosts by this field.

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

Direction of sort. Options include asc and desc.

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

Specify the starting point for the host search results. For example, if you set count to 100 and the first 100 results have already been returned, you can set start to 101 to get the next 100 results.

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

Number of hosts to return. Max 1000.

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

Number of seconds since UNIX epoch from which you want to search your hosts.

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

Include information on the muted status of hosts and when the mute expires.

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

Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.).

Examples found in repository

examples/v1_hosts_ListHosts_2975406675.rs (line 11)

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

examples/v1_hosts_ListHosts_347346033.rs (line 11)

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

Trait Implementations

impl Clone for ListHostsOptionalParams

fn clone(&self) -> ListHostsOptionalParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListHostsOptionalParams

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

Formats the value using the given formatter.

impl Default for ListHostsOptionalParams

fn default() -> ListHostsOptionalParams

Returns the “default value” for a type.