Struct aws_sdk_connect::types::UserSearchCriteria

#[non_exhaustive]
pub struct UserSearchCriteria {
    pub or_conditions: Option<Vec<UserSearchCriteria>>,
    pub and_conditions: Option<Vec<UserSearchCriteria>>,
    pub string_condition: Option<StringCondition>,
    pub list_condition: Option<ListCondition>,
    pub hierarchy_group_condition: Option<HierarchyGroupCondition>,
}

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

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.

or_conditions: Option<Vec<UserSearchCriteria>>

A list of conditions which would be applied together with an OR condition.

and_conditions: Option<Vec<UserSearchCriteria>>

A list of conditions which would be applied together with an AND condition.

string_condition: Option<StringCondition>

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

list_condition: Option<ListCondition>

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

hierarchy_group_condition: Option<HierarchyGroupCondition>

A leaf node condition which can be used to specify a hierarchy group condition.

Implementations

impl UserSearchCriteria

pub fn or_conditions(&self) -> &[UserSearchCriteria]

A list of conditions which would be applied together with an OR condition.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .or_conditions.is_none().

pub fn and_conditions(&self) -> &[UserSearchCriteria]

A list of conditions which would be applied together with an AND condition.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .and_conditions.is_none().

pub fn string_condition(&self) -> Option<&StringCondition>

A leaf node condition which can be used to specify a string condition.

The currently supported values for FieldName are Username, FirstName, LastName, RoutingProfileId, SecurityProfileId, ResourceId.

pub fn list_condition(&self) -> Option<&ListCondition>

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

pub fn hierarchy_group_condition(&self) -> Option<&HierarchyGroupCondition>

A leaf node condition which can be used to specify a hierarchy group condition.

impl UserSearchCriteria

pub fn builder() -> UserSearchCriteriaBuilder

Creates a new builder-style object to manufacture UserSearchCriteria.

Trait Implementations

impl Clone for UserSearchCriteria

fn clone(&self) -> UserSearchCriteria

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserSearchCriteria

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

Formats the value using the given formatter.

impl PartialEq for UserSearchCriteria

fn eq(&self, other: &UserSearchCriteria) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserSearchCriteria