Class SearchCriteria

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:

  • Method Details

    • 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 identifiers of agents who handled the contacts.

      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 identifiers of agents who handled the contacts.

    • agentHierarchyGroups

      public final AgentHierarchyGroups agentHierarchyGroups()

      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.

    • channels

      public final List<Channel> channels()

      The list of channels associated with contacts.

      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 list of channels associated with contacts.

    • 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 list of channels associated with contacts.

      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 list of channels associated with contacts.

    • contactAnalysis

      public final ContactAnalysis contactAnalysis()

      Search criteria based on analysis outputs from Amazon Connect Contact Lens.

      Returns:
      Search criteria based on analysis outputs from Amazon Connect Contact Lens.

    • initiationMethods

      public final List<ContactInitiationMethod> initiationMethods()

      The list of initiation methods associated with contacts.

      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 list of initiation methods associated with contacts.

    • 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 list of initiation methods associated with contacts.

      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 list of initiation methods associated with contacts.

    • 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 list of queue IDs associated with contacts.

      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 list of queue IDs associated with contacts.

    • searchableContactAttributes

      public final 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.

      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.

    • searchableSegmentAttributes

      public final SearchableSegmentAttributes searchableSegmentAttributes()

      The search criteria based on searchable segment attributes of a contact.

      Returns:
      The search criteria based on searchable segment attributes of a contact.

    • toBuilder

      public SearchCriteria.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SearchCriteria.Builder,SearchCriteria>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.