SearchCriteria (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchCriteria
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A structure of search criteria to be used to return contacts.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchCriteria()

Constructors
Constructor and Description
`SearchCriteria()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchCriteria`	`clone()`
`boolean`	`equals(Object obj)`
`AgentHierarchyGroups`	`getAgentHierarchyGroups()` The agent hierarchy groups of the agent at the time of handling the contact.
`List<String>`	`getAgentIds()` The identifiers of agents who handled the contacts.
`List<String>`	`getChannels()` The list of channels associated with contacts.
`ContactAnalysis`	`getContactAnalysis()` Search criteria based on analysis outputs from Amazon Connect Contact Lens.
`List<String>`	`getInitiationMethods()` The list of initiation methods associated with contacts.
`List<String>`	`getQueueIds()` The list of queue IDs associated with contacts.
`SearchableContactAttributes`	`getSearchableContactAttributes()` The search criteria based on user-defined contact attributes that have been configured for contact search.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAgentHierarchyGroups(AgentHierarchyGroups agentHierarchyGroups)` The agent hierarchy groups of the agent at the time of handling the contact.
`void`	`setAgentIds(Collection<String> agentIds)` The identifiers of agents who handled the contacts.
`void`	`setChannels(Collection<String> channels)` The list of channels associated with contacts.
`void`	`setContactAnalysis(ContactAnalysis contactAnalysis)` Search criteria based on analysis outputs from Amazon Connect Contact Lens.
`void`	`setInitiationMethods(Collection<String> initiationMethods)` The list of initiation methods associated with contacts.
`void`	`setQueueIds(Collection<String> queueIds)` The list of queue IDs associated with contacts.
`void`	`setSearchableContactAttributes(SearchableContactAttributes searchableContactAttributes)` The search criteria based on user-defined contact attributes that have been configured for contact search.
`String`	`toString()` Returns a string representation of this object.
`SearchCriteria`	`withAgentHierarchyGroups(AgentHierarchyGroups agentHierarchyGroups)` The agent hierarchy groups of the agent at the time of handling the contact.
`SearchCriteria`	`withAgentIds(Collection<String> agentIds)` The identifiers of agents who handled the contacts.
`SearchCriteria`	`withAgentIds(String... agentIds)` The identifiers of agents who handled the contacts.
`SearchCriteria`	`withChannels(Channel... channels)` The list of channels associated with contacts.
`SearchCriteria`	`withChannels(Collection<String> channels)` The list of channels associated with contacts.
`SearchCriteria`	`withChannels(String... channels)` The list of channels associated with contacts.
`SearchCriteria`	`withContactAnalysis(ContactAnalysis contactAnalysis)` Search criteria based on analysis outputs from Amazon Connect Contact Lens.
`SearchCriteria`	`withInitiationMethods(Collection<String> initiationMethods)` The list of initiation methods associated with contacts.
`SearchCriteria`	`withInitiationMethods(ContactInitiationMethod... initiationMethods)` The list of initiation methods associated with contacts.
`SearchCriteria`	`withInitiationMethods(String... initiationMethods)` The list of initiation methods associated with contacts.
`SearchCriteria`	`withQueueIds(Collection<String> queueIds)` The list of queue IDs associated with contacts.
`SearchCriteria`	`withQueueIds(String... queueIds)` The list of queue IDs associated with contacts.
`SearchCriteria`	`withSearchableContactAttributes(SearchableContactAttributes searchableContactAttributes)` The search criteria based on user-defined contact attributes that have been configured for contact search.

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

- Constructor Detail
  - SearchCriteria
```
public SearchCriteria()
```
- Method Detail
  - getAgentIds
```
public List<String> getAgentIds()
```
    The identifiers of agents who handled the contacts.
    
    Returns:
    
    The identifiers of agents who handled the contacts.
  - setAgentIds
```
public void setAgentIds(Collection<String> agentIds)
```
    The identifiers of agents who handled the contacts.
    
    Parameters:
    
    agentIds - The identifiers of agents who handled the contacts.
  - withAgentIds
```
public SearchCriteria withAgentIds(String... agentIds)
```
    The identifiers of agents who handled the contacts.
    
    NOTE: This method appends the values to the existing list (if any). Use setAgentIds(java.util.Collection) or withAgentIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    agentIds - The identifiers of agents who handled the contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAgentIds
```
public SearchCriteria withAgentIds(Collection<String> agentIds)
```
    The identifiers of agents who handled the contacts.
    
    Parameters:
    
    agentIds - The identifiers of agents who handled the contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentHierarchyGroups
```
public void setAgentHierarchyGroups(AgentHierarchyGroups agentHierarchyGroups)
```
    The agent hierarchy groups of the agent at the time of handling the contact.
    
    Parameters:
    
    agentHierarchyGroups - The agent hierarchy groups of the agent at the time of handling the contact.
  - getAgentHierarchyGroups
```
public AgentHierarchyGroups getAgentHierarchyGroups()
```
    The agent hierarchy groups of the agent at the time of handling the contact.
    
    Returns:
    
    The agent hierarchy groups of the agent at the time of handling the contact.
  - withAgentHierarchyGroups
```
public SearchCriteria withAgentHierarchyGroups(AgentHierarchyGroups agentHierarchyGroups)
```
    The agent hierarchy groups of the agent at the time of handling the contact.
    
    Parameters:
    
    agentHierarchyGroups - The agent hierarchy groups of the agent at the time of handling the contact.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getChannels
```
public List<String> getChannels()
```
    The list of channels associated with contacts.
    
    Returns:
    
    The list of channels associated with contacts.
    
    See Also:
    
    Channel
  - setChannels
```
public void setChannels(Collection<String> channels)
```
    The list of channels associated with contacts.
    
    Parameters:
    
    channels - The list of channels associated with contacts.
    
    See Also:
    
    Channel
  - withChannels
```
public SearchCriteria withChannels(String... channels)
```
    The list of channels associated with contacts.
    
    NOTE: This method appends the values to the existing list (if any). Use setChannels(java.util.Collection) or withChannels(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    channels - The list of channels associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Channel
  - withChannels
```
public SearchCriteria withChannels(Collection<String> channels)
```
    The list of channels associated with contacts.
    
    Parameters:
    
    channels - The list of channels associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Channel
  - withChannels
```
public SearchCriteria withChannels(Channel... channels)
```
    The list of channels associated with contacts.
    
    Parameters:
    
    channels - The list of channels associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Channel
  - setContactAnalysis
```
public void setContactAnalysis(ContactAnalysis contactAnalysis)
```
    Search criteria based on analysis outputs from Amazon Connect Contact Lens.
    
    Parameters:
    
    contactAnalysis - Search criteria based on analysis outputs from Amazon Connect Contact Lens.
  - getContactAnalysis
```
public ContactAnalysis getContactAnalysis()
```
    Search criteria based on analysis outputs from Amazon Connect Contact Lens.
    
    Returns:
    
    Search criteria based on analysis outputs from Amazon Connect Contact Lens.
  - withContactAnalysis
```
public SearchCriteria withContactAnalysis(ContactAnalysis contactAnalysis)
```
    Search criteria based on analysis outputs from Amazon Connect Contact Lens.
    
    Parameters:
    
    contactAnalysis - Search criteria based on analysis outputs from Amazon Connect Contact Lens.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInitiationMethods
```
public List<String> getInitiationMethods()
```
    The list of initiation methods associated with contacts.
    
    Returns:
    
    The list of initiation methods associated with contacts.
    
    See Also:
    
    ContactInitiationMethod
  - setInitiationMethods
```
public void setInitiationMethods(Collection<String> initiationMethods)
```
    The list of initiation methods associated with contacts.
    
    Parameters:
    
    initiationMethods - The list of initiation methods associated with contacts.
    
    See Also:
    
    ContactInitiationMethod
  - withInitiationMethods
```
public SearchCriteria withInitiationMethods(String... initiationMethods)
```
    The list of initiation methods associated with contacts.
    
    NOTE: This method appends the values to the existing list (if any). Use setInitiationMethods(java.util.Collection) or withInitiationMethods(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    initiationMethods - The list of initiation methods associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactInitiationMethod
  - withInitiationMethods
```
public SearchCriteria withInitiationMethods(Collection<String> initiationMethods)
```
    The list of initiation methods associated with contacts.
    
    Parameters:
    
    initiationMethods - The list of initiation methods associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactInitiationMethod
  - withInitiationMethods
```
public SearchCriteria withInitiationMethods(ContactInitiationMethod... initiationMethods)
```
    The list of initiation methods associated with contacts.
    
    Parameters:
    
    initiationMethods - The list of initiation methods associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactInitiationMethod
  - getQueueIds
```
public List<String> getQueueIds()
```
    The list of queue IDs associated with contacts.
    
    Returns:
    
    The list of queue IDs associated with contacts.
  - setQueueIds
```
public void setQueueIds(Collection<String> queueIds)
```
    The list of queue IDs associated with contacts.
    
    Parameters:
    
    queueIds - The list of queue IDs associated with contacts.
  - withQueueIds
```
public SearchCriteria withQueueIds(String... queueIds)
```
    The list of queue IDs associated with contacts.
    
    NOTE: This method appends the values to the existing list (if any). Use setQueueIds(java.util.Collection) or withQueueIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    queueIds - The list of queue IDs associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withQueueIds
```
public SearchCriteria withQueueIds(Collection<String> queueIds)
```
    The list of queue IDs associated with contacts.
    
    Parameters:
    
    queueIds - The list of queue IDs associated with contacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSearchableContactAttributes
```
public void setSearchableContactAttributes(SearchableContactAttributes searchableContactAttributes)
```
    The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions -as-permissionsActions defined by Amazon Connect.
    
    Parameters:
    
    searchableContactAttributes - The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect- actions-as-permissionsActions defined by Amazon Connect.
  - getSearchableContactAttributes
```
public SearchableContactAttributes getSearchableContactAttributes()
```
    The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions -as-permissionsActions defined by Amazon Connect.
    
    Returns:
    
    The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect -actions-as-permissionsActions defined by Amazon Connect.
  - withSearchableContactAttributes
```
public SearchCriteria withSearchableContactAttributes(SearchableContactAttributes searchableContactAttributes)
```
    The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions -as-permissionsActions defined by Amazon Connect.
    
    Parameters:
    
    searchableContactAttributes - The search criteria based on user-defined contact attributes that have been configured for contact search. For more information, see Search by custom contact attributes in the Amazon Connect Administrator Guide.
    
    To use SearchableContactAttributes in a search request, the GetContactAttributes action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect- actions-as-permissionsActions defined by Amazon Connect.
    
    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 SearchCriteria 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.793

Class SearchCriteria

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchCriteria

Method Detail

getAgentIds

setAgentIds

withAgentIds

withAgentIds

setAgentHierarchyGroups

getAgentHierarchyGroups

withAgentHierarchyGroups

getChannels

setChannels

withChannels

withChannels

withChannels

setContactAnalysis

getContactAnalysis

withContactAnalysis

getInitiationMethods

setInitiationMethods

withInitiationMethods

withInitiationMethods

withInitiationMethods

getQueueIds

setQueueIds

withQueueIds

withQueueIds

setSearchableContactAttributes

getSearchableContactAttributes

withSearchableContactAttributes

toString

equals

hashCode

clone

marshall