Struct datadog_api_client::datadogV2::api::api_users::ListUsersOptionalParams

#[non_exhaustive]
pub struct ListUsersOptionalParams {
    pub page_size: Option<i64>,
    pub page_number: Option<i64>,
    pub sort: Option<String>,
    pub sort_dir: Option<QuerySortOrder>,
    pub filter: Option<String>,
    pub filter_status: Option<String>,
}

ListUsersOptionalParams is a struct for passing parameters to the method UsersAPI::list_users

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.

page_size: Option<i64>

Size for a given page. The maximum allowed value is 100.

page_number: Option<i64>

Specific page number to return.

sort: Option<String>

User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example sort=-name. Options: name, modified_at, user_count.

sort_dir: Option<QuerySortOrder>

Direction of sort. Options: asc, desc.

filter: Option<String>

Filter all users by the given string. Defaults to no filtering.

filter_status: Option<String>

Filter on status attribute. Comma separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.

Implementations

impl ListUsersOptionalParams

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

Size for a given page. The maximum allowed value is 100.

Examples found in repository

examples/v2_users_ListUsers_4075885358.rs (line 12)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = UsersAPI::with_config(configuration);
    let response = api.list_users_with_pagination(ListUsersOptionalParams::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());
        }
    }
}

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

Specific page number to return.

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

User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example sort=-name. Options: name, modified_at, user_count.

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

Direction of sort. Options: asc, desc.

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

Filter all users by the given string. Defaults to no filtering.

Examples found in repository

examples/v2_users_ListUsers.rs (line 13)

async fn main() {
    // there is a valid "user" in the system
    let user_data_attributes_email = std::env::var("USER_DATA_ATTRIBUTES_EMAIL").unwrap();
    let configuration = datadog::Configuration::new();
    let api = UsersAPI::with_config(configuration);
    let resp = api
        .list_users(ListUsersOptionalParams::default().filter(user_data_attributes_email.clone()))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

Filter on status attribute. Comma separated list, with possible values Active, Pending, and Disabled. Defaults to no filtering.

Trait Implementations

impl Clone for ListUsersOptionalParams

fn clone(&self) -> ListUsersOptionalParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListUsersOptionalParams

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

Formats the value using the given formatter.

impl Default for ListUsersOptionalParams

fn default() -> ListUsersOptionalParams

Returns the “default value” for a type.