UserSearchCriteria (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connect.model.UserSearchCriteria

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserSearchCriteria
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserSearchCriteria()

Constructors
Constructor and Description
`UserSearchCriteria()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserSearchCriteria`	`clone()`
`boolean`	`equals(Object obj)`
`List<UserSearchCriteria>`	`getAndConditions()` A list of conditions which would be applied together with an `AND` condition.
`HierarchyGroupCondition`	`getHierarchyGroupCondition()` A leaf node condition which can be used to specify a hierarchy group condition.
`ListCondition`	`getListCondition()` A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
`List<UserSearchCriteria>`	`getOrConditions()` A list of conditions which would be applied together with an `OR` condition.
`StringCondition`	`getStringCondition()` A leaf node condition which can be used to specify a string condition.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAndConditions(Collection<UserSearchCriteria> andConditions)` A list of conditions which would be applied together with an `AND` condition.
`void`	`setHierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition)` A leaf node condition which can be used to specify a hierarchy group condition.
`void`	`setListCondition(ListCondition listCondition)` A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
`void`	`setOrConditions(Collection<UserSearchCriteria> orConditions)` A list of conditions which would be applied together with an `OR` condition.
`void`	`setStringCondition(StringCondition stringCondition)` A leaf node condition which can be used to specify a string condition.
`String`	`toString()` Returns a string representation of this object.
`UserSearchCriteria`	`withAndConditions(Collection<UserSearchCriteria> andConditions)` A list of conditions which would be applied together with an `AND` condition.
`UserSearchCriteria`	`withAndConditions(UserSearchCriteria... andConditions)` A list of conditions which would be applied together with an `AND` condition.
`UserSearchCriteria`	`withHierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition)` A leaf node condition which can be used to specify a hierarchy group condition.
`UserSearchCriteria`	`withListCondition(ListCondition listCondition)` A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
`UserSearchCriteria`	`withOrConditions(Collection<UserSearchCriteria> orConditions)` A list of conditions which would be applied together with an `OR` condition.
`UserSearchCriteria`	`withOrConditions(UserSearchCriteria... orConditions)` A list of conditions which would be applied together with an `OR` condition.
`UserSearchCriteria`	`withStringCondition(StringCondition stringCondition)` A leaf node condition which can be used to specify a string condition.

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

- Constructor Detail
  - UserSearchCriteria
```
public UserSearchCriteria()
```
- Method Detail
  - getOrConditions
```
public List<UserSearchCriteria> getOrConditions()
```
    A list of conditions which would be applied together with an OR condition.
    
    Returns:
    
    A list of conditions which would be applied together with an OR condition.
  - setOrConditions
```
public void setOrConditions(Collection<UserSearchCriteria> orConditions)
```
    A list of conditions which would be applied together with an OR condition.
    
    Parameters:
    
    orConditions - A list of conditions which would be applied together with an OR condition.
  - withOrConditions
```
public UserSearchCriteria withOrConditions(UserSearchCriteria... orConditions)
```
    A list of conditions which would be applied together with an OR condition.
    
    NOTE: This method appends the values to the existing list (if any). Use setOrConditions(java.util.Collection) or withOrConditions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    orConditions - A list of conditions which would be applied together with an OR condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOrConditions
```
public UserSearchCriteria withOrConditions(Collection<UserSearchCriteria> orConditions)
```
    A list of conditions which would be applied together with an OR condition.
    
    Parameters:
    
    orConditions - A list of conditions which would be applied together with an OR condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAndConditions
```
public List<UserSearchCriteria> getAndConditions()
```
    A list of conditions which would be applied together with an AND condition.
    
    Returns:
    
    A list of conditions which would be applied together with an AND condition.
  - setAndConditions
```
public void setAndConditions(Collection<UserSearchCriteria> andConditions)
```
    A list of conditions which would be applied together with an AND condition.
    
    Parameters:
    
    andConditions - A list of conditions which would be applied together with an AND condition.
  - withAndConditions
```
public UserSearchCriteria withAndConditions(UserSearchCriteria... andConditions)
```
    A list of conditions which would be applied together with an AND condition.
    
    NOTE: This method appends the values to the existing list (if any). Use setAndConditions(java.util.Collection) or withAndConditions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    andConditions - A list of conditions which would be applied together with an AND condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAndConditions
```
public UserSearchCriteria withAndConditions(Collection<UserSearchCriteria> andConditions)
```
    A list of conditions which would be applied together with an AND condition.
    
    Parameters:
    
    andConditions - A list of conditions which would be applied together with an AND condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStringCondition
```
public void setStringCondition(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.
    
    Parameters:
    
    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.
  - getStringCondition
```
public StringCondition getStringCondition()
```
    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.
  - withStringCondition
```
public UserSearchCriteria withStringCondition(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setListCondition
```
public void setListCondition(ListCondition listCondition)
```
    A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
    
    Parameters:
    
    listCondition - A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
  - getListCondition
```
public ListCondition getListCondition()
```
    A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
    
    Returns:
    
    A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
  - withListCondition
```
public UserSearchCriteria withListCondition(ListCondition listCondition)
```
    A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
    
    Parameters:
    
    listCondition - A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHierarchyGroupCondition
```
public void setHierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition)
```
    A leaf node condition which can be used to specify a hierarchy group condition.
    
    Parameters:
    
    hierarchyGroupCondition - A leaf node condition which can be used to specify a hierarchy group condition.
  - getHierarchyGroupCondition
```
public HierarchyGroupCondition getHierarchyGroupCondition()
```
    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.
  - withHierarchyGroupCondition
```
public UserSearchCriteria withHierarchyGroupCondition(HierarchyGroupCondition hierarchyGroupCondition)
```
    A leaf node condition which can be used to specify a hierarchy group condition.
    
    Parameters:
    
    hierarchyGroupCondition - A leaf node condition which can be used to specify a hierarchy group condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserSearchCriteria clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.796

Class UserSearchCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserSearchCriteria

Method Detail

getOrConditions

setOrConditions

withOrConditions

withOrConditions

getAndConditions

setAndConditions

withAndConditions

withAndConditions

setStringCondition

getStringCondition

withStringCondition

setListCondition

getListCondition

withListCondition

setHierarchyGroupCondition

getHierarchyGroupCondition

withHierarchyGroupCondition

toString

equals

hashCode

clone

marshall