Struct ListRolesOptionalParams

#[non_exhaustive]
pub struct ListRolesOptionalParams {
    pub page_size: Option<i64>,
    pub page_number: Option<i64>,
    pub sort: Option<RolesSort>,
    pub filter: Option<String>,
    pub filter_id: Option<String>,
}

ListRolesOptionalParams is a struct for passing parameters to the method RolesAPI::list_roles

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<RolesSort>

Sort roles depending on the given field. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example: sort=-name.

filter: Option<String>

Filter all roles by the given string.

filter_id: Option<String>

Filter all roles by the given list of role IDs.

Implementations

impl ListRolesOptionalParams

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

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

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

Specific page number to return.

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

Sort roles depending on the given field. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example: sort=-name.

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

Filter all roles by the given string.

Examples found in repository

examples/v2_roles_ListRoles.rs (line 13)

async fn main() {
    // there is a valid "role" in the system
    let role_data_attributes_name = std::env::var("ROLE_DATA_ATTRIBUTES_NAME").unwrap();
    let configuration = datadog::Configuration::new();
    let api = RolesAPI::with_config(configuration);
    let resp = api
        .list_roles(ListRolesOptionalParams::default().filter(role_data_attributes_name.clone()))
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

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

Filter all roles by the given list of role IDs.

Trait Implementations

impl Clone for ListRolesOptionalParams

fn clone(&self) -> ListRolesOptionalParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListRolesOptionalParams

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

Formats the value using the given formatter.

impl Default for ListRolesOptionalParams

fn default() -> ListRolesOptionalParams

Returns the “default value” for a type.