java.lang.Object
- software.amazon.awssdk.services.connect.model.UserSearchCriteria

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<UserSearchCriteria.Builder,UserSearchCriteria>
```
@Generated("software.amazon.awssdk:codegen")
public final class UserSearchCriteria
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserSearchCriteria.Builder,UserSearchCriteria>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UserSearchCriteria.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<UserSearchCriteria>`	`andConditions()`	A list of conditions which would be applied together with an `AND` condition.
`static UserSearchCriteria.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAndConditions()`	For responses, this returns true if the service returned a value for the AndConditions property.
`int`	`hashCode()`
`boolean`	`hasOrConditions()`	For responses, this returns true if the service returned a value for the OrConditions property.
`HierarchyGroupCondition`	`hierarchyGroupCondition()`	A leaf node condition which can be used to specify a hierarchy group condition.
`List<UserSearchCriteria>`	`orConditions()`	A list of conditions which would be applied together with an `OR` condition.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserSearchCriteria.Builder>`	`serializableBuilderClass()`
`StringCondition`	`stringCondition()`	A leaf node condition which can be used to specify a string condition.
`UserSearchCriteria.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasOrConditions
```
public final boolean hasOrConditions()
```
    For responses, this returns true if the service returned a value for the OrConditions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - orConditions
```
public final List<UserSearchCriteria> orConditions()
```
    A list of conditions which would be applied together with an OR condition.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrConditions() method.
    
    Returns:
    
    A list of conditions which would be applied together with an OR condition.
  - hasAndConditions
```
public final boolean hasAndConditions()
```
    For responses, this returns true if the service returned a value for the AndConditions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - andConditions
```
public final List<UserSearchCriteria> andConditions()
```
    A list of conditions which would be applied together with an AND condition.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAndConditions() method.
    
    Returns:
    
    A list of conditions which would be applied together with an AND condition.
  - stringCondition
```
public final StringCondition 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.
    
    Returns:
    
    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.
  - hierarchyGroupCondition
```
public final HierarchyGroupCondition hierarchyGroupCondition()
```
    A leaf node condition which can be used to specify a hierarchy group condition.
    
    Returns:
    
    A leaf node condition which can be used to specify a hierarchy group condition.
  - toBuilder
```
public UserSearchCriteria.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserSearchCriteria.Builder,UserSearchCriteria>
  - builder
```
public static UserSearchCriteria.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserSearchCriteria.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UserSearchCriteria

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasOrConditions

orConditions

hasAndConditions

andConditions

stringCondition

hierarchyGroupCondition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields