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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SearchCriteria.Builder,SearchCriteria>

@Generated("software.amazon.awssdk:codegen")
public final class SearchCriteria
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchCriteria.Builder,SearchCriteria>

A structure of search criteria to be used to return contacts

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SearchCriteria.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AgentHierarchyGroups`	`agentHierarchyGroups()`	The agent hierarchy groups
`List<String>`	`agentIds()`	The array of agent ids
`static SearchCriteria.Builder`	`builder()`
`List<Channel>`	`channels()`	The array of channels
`List<String>`	`channelsAsStrings()`	The array of channels
`ContactAnalysis`	`contactAnalysis()`	The ContactAnalysis object used in search criteria
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAgentIds()`	For responses, this returns true if the service returned a value for the AgentIds property.
`boolean`	`hasChannels()`	For responses, this returns true if the service returned a value for the Channels property.
`int`	`hashCode()`
`boolean`	`hasInitiationMethods()`	For responses, this returns true if the service returned a value for the InitiationMethods property.
`boolean`	`hasQueueIds()`	For responses, this returns true if the service returned a value for the QueueIds property.
`List<ContactInitiationMethod>`	`initiationMethods()`	The array of initiaton methods
`List<String>`	`initiationMethodsAsStrings()`	The array of initiaton methods
`List<String>`	`queueIds()`	The array of queue ids.
`List<SdkField<?>>`	`sdkFields()`
`SearchableContactAttributes`	`searchableContactAttributes()`	The SearchableContactAttributes object used in search criteria
`static Class<? extends SearchCriteria.Builder>`	`serializableBuilderClass()`
`SearchCriteria.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
  - hasAgentIds
```
public final boolean hasAgentIds()
```
    For responses, this returns true if the service returned a value for the AgentIds 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.
  - agentIds
```
public final List<String> agentIds()
```
    The array of agent ids
    
    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 hasAgentIds() method.
    
    Returns:
    
    The array of agent ids
  - agentHierarchyGroups
```
public final AgentHierarchyGroups agentHierarchyGroups()
```
    The agent hierarchy groups
    
    Returns:
    
    The agent hierarchy groups
  - channels
```
public final List<Channel> channels()
```
    The array of channels
    
    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 hasChannels() method.
    
    Returns:
    
    The array of channels
  - hasChannels
```
public final boolean hasChannels()
```
    For responses, this returns true if the service returned a value for the Channels 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.
  - channelsAsStrings
```
public final List<String> channelsAsStrings()
```
    The array of channels
    
    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 hasChannels() method.
    
    Returns:
    
    The array of channels
  - contactAnalysis
```
public final ContactAnalysis contactAnalysis()
```
    The ContactAnalysis object used in search criteria
    
    Returns:
    
    The ContactAnalysis object used in search criteria
  - initiationMethods
```
public final List<ContactInitiationMethod> initiationMethods()
```
    The array of initiaton methods
    
    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 hasInitiationMethods() method.
    
    Returns:
    
    The array of initiaton methods
  - hasInitiationMethods
```
public final boolean hasInitiationMethods()
```
    For responses, this returns true if the service returned a value for the InitiationMethods 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.
  - initiationMethodsAsStrings
```
public final List<String> initiationMethodsAsStrings()
```
    The array of initiaton methods
    
    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 hasInitiationMethods() method.
    
    Returns:
    
    The array of initiaton methods
  - hasQueueIds
```
public final boolean hasQueueIds()
```
    For responses, this returns true if the service returned a value for the QueueIds 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.
  - queueIds
```
public final List<String> queueIds()
```
    The array of queue ids.
    
    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 hasQueueIds() method.
    
    Returns:
    
    The array of queue ids.
  - searchableContactAttributes
```
public final SearchableContactAttributes searchableContactAttributes()
```
    The SearchableContactAttributes object used in search criteria
    
    Returns:
    
    The SearchableContactAttributes object used in search criteria
  - toBuilder
```
public SearchCriteria.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SearchCriteria.Builder,SearchCriteria>
  - builder
```
public static SearchCriteria.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SearchCriteria.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 SearchCriteria

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAgentIds

agentIds

agentHierarchyGroups

channels

hasChannels

channelsAsStrings

contactAnalysis

initiationMethods

hasInitiationMethods

initiationMethodsAsStrings

hasQueueIds

queueIds

searchableContactAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields