Interface SearchCriteria.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SearchCriteria.Builder,SearchCriteria>, SdkBuilder<SearchCriteria.Builder,SearchCriteria>, SdkPojo

Enclosing class:

SearchCriteria

@Mutable
@NotThreadSafe
public static interface SearchCriteria.Builder
extends SdkPojo, CopyableBuilder<SearchCriteria.Builder,SearchCriteria>

Method Summary

Modifier and Type	Method	Description
default SearchCriteria.Builder	additionalTimeRange(Consumer<SearchContactsAdditionalTimeRange.Builder> additionalTimeRange)	Additional TimeRange used to filter contacts.
SearchCriteria.Builder	additionalTimeRange(SearchContactsAdditionalTimeRange additionalTimeRange)	Additional TimeRange used to filter contacts.
default SearchCriteria.Builder	agentHierarchyGroups(Consumer<AgentHierarchyGroups.Builder> agentHierarchyGroups)	The agent hierarchy groups of the agent at the time of handling the contact.
SearchCriteria.Builder	agentHierarchyGroups(AgentHierarchyGroups agentHierarchyGroups)	The agent hierarchy groups of the agent at the time of handling the contact.
SearchCriteria.Builder	agentIds(String... agentIds)	The identifiers of agents who handled the contacts.
SearchCriteria.Builder	agentIds(Collection<String> agentIds)	The identifiers of agents who handled the contacts.
SearchCriteria.Builder	channels(Collection<Channel> channels)	The list of channels associated with contacts.
SearchCriteria.Builder	channels(Channel... channels)	The list of channels associated with contacts.
SearchCriteria.Builder	channelsWithStrings(String... channels)	The list of channels associated with contacts.
SearchCriteria.Builder	channelsWithStrings(Collection<String> channels)	The list of channels associated with contacts.
default SearchCriteria.Builder	contactAnalysis(Consumer<ContactAnalysis.Builder> contactAnalysis)	Search criteria based on analysis outputs from Amazon Connect Contact Lens.
SearchCriteria.Builder	contactAnalysis(ContactAnalysis contactAnalysis)	Search criteria based on analysis outputs from Amazon Connect Contact Lens.
SearchCriteria.Builder	initiationMethods(Collection<ContactInitiationMethod> initiationMethods)	The list of initiation methods associated with contacts.
SearchCriteria.Builder	initiationMethods(ContactInitiationMethod... initiationMethods)	The list of initiation methods associated with contacts.
SearchCriteria.Builder	initiationMethodsWithStrings(String... initiationMethods)	The list of initiation methods associated with contacts.
SearchCriteria.Builder	initiationMethodsWithStrings(Collection<String> initiationMethods)	The list of initiation methods associated with contacts.
default SearchCriteria.Builder	name(Consumer<NameCriteria.Builder> name)	Name of the contact.
SearchCriteria.Builder	name(NameCriteria name)	Name of the contact.
SearchCriteria.Builder	queueIds(String... queueIds)	The list of queue IDs associated with contacts.
SearchCriteria.Builder	queueIds(Collection<String> queueIds)	The list of queue IDs associated with contacts.
default SearchCriteria.Builder	routingCriteria(Consumer<SearchableRoutingCriteria.Builder> routingCriteria)	Routing criteria for the contact.
SearchCriteria.Builder	routingCriteria(SearchableRoutingCriteria routingCriteria)	Routing criteria for the contact.
default SearchCriteria.Builder	searchableContactAttributes(Consumer<SearchableContactAttributes.Builder> searchableContactAttributes)	The search criteria based on user-defined contact attributes that have been configured for contact search.
SearchCriteria.Builder	searchableContactAttributes(SearchableContactAttributes searchableContactAttributes)	The search criteria based on user-defined contact attributes that have been configured for contact search.
default SearchCriteria.Builder	searchableSegmentAttributes(Consumer<SearchableSegmentAttributes.Builder> searchableSegmentAttributes)	The search criteria based on searchable segment attributes of a contact.
SearchCriteria.Builder	searchableSegmentAttributes(SearchableSegmentAttributes searchableSegmentAttributes)	The search criteria based on searchable segment attributes of a contact.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

SearchCriteria.Builder name(NameCriteria name)

Name of the contact.

Parameters:

name - Name of the contact.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

default SearchCriteria.Builder name(Consumer<NameCriteria.Builder> name)

Name of the contact.

This is a convenience method that creates an instance of the NameCriteria.Builder avoiding the need to create one manually via NameCriteria.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to name(NameCriteria).

Parameters:

name - a consumer that will call methods on NameCriteria.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• name(NameCriteria)

agentIds

SearchCriteria.Builder agentIds(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.

agentIds

SearchCriteria.Builder agentIds(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.

agentHierarchyGroups

SearchCriteria.Builder agentHierarchyGroups(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.

agentHierarchyGroups

default SearchCriteria.Builder agentHierarchyGroups(Consumer<AgentHierarchyGroups.Builder> agentHierarchyGroups)

The agent hierarchy groups of the agent at the time of handling the contact.

This is a convenience method that creates an instance of the AgentHierarchyGroups.Builder avoiding the need to create one manually via AgentHierarchyGroups.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to agentHierarchyGroups(AgentHierarchyGroups).

Parameters:

agentHierarchyGroups - a consumer that will call methods on AgentHierarchyGroups.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• agentHierarchyGroups(AgentHierarchyGroups)

channelsWithStrings

SearchCriteria.Builder channelsWithStrings(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.

channelsWithStrings

SearchCriteria.Builder channelsWithStrings(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.

channels

SearchCriteria.Builder channels(Collection<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.

channels

SearchCriteria.Builder channels(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.

contactAnalysis

SearchCriteria.Builder contactAnalysis(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.

contactAnalysis

default SearchCriteria.Builder contactAnalysis(Consumer<ContactAnalysis.Builder> contactAnalysis)

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

This is a convenience method that creates an instance of the ContactAnalysis.Builder avoiding the need to create one manually via ContactAnalysis.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contactAnalysis(ContactAnalysis).

Parameters:

contactAnalysis - a consumer that will call methods on ContactAnalysis.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• contactAnalysis(ContactAnalysis)

initiationMethodsWithStrings

SearchCriteria.Builder initiationMethodsWithStrings(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.

initiationMethodsWithStrings

SearchCriteria.Builder initiationMethodsWithStrings(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.

initiationMethods

SearchCriteria.Builder initiationMethods(Collection<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.

initiationMethods

SearchCriteria.Builder initiationMethods(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.

queueIds

SearchCriteria.Builder queueIds(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.

queueIds

SearchCriteria.Builder queueIds(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.

routingCriteria

SearchCriteria.Builder routingCriteria(SearchableRoutingCriteria routingCriteria)

Routing criteria for the contact.

Parameters:

routingCriteria - Routing criteria for the contact.

Returns:

Returns a reference to this object so that method calls can be chained together.

routingCriteria

default SearchCriteria.Builder routingCriteria(Consumer<SearchableRoutingCriteria.Builder> routingCriteria)

Routing criteria for the contact.

This is a convenience method that creates an instance of the SearchableRoutingCriteria.Builder avoiding the need to create one manually via SearchableRoutingCriteria.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to routingCriteria(SearchableRoutingCriteria).

Parameters:

routingCriteria - a consumer that will call methods on SearchableRoutingCriteria.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• routingCriteria(SearchableRoutingCriteria)

additionalTimeRange

SearchCriteria.Builder additionalTimeRange(SearchContactsAdditionalTimeRange additionalTimeRange)

Additional TimeRange used to filter contacts.

Parameters:

additionalTimeRange - Additional TimeRange used to filter contacts.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalTimeRange

default SearchCriteria.Builder additionalTimeRange(Consumer<SearchContactsAdditionalTimeRange.Builder> additionalTimeRange)

Additional TimeRange used to filter contacts.

This is a convenience method that creates an instance of the SearchContactsAdditionalTimeRange.Builder avoiding the need to create one manually via SearchContactsAdditionalTimeRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalTimeRange(SearchContactsAdditionalTimeRange).

Parameters:

additionalTimeRange - a consumer that will call methods on SearchContactsAdditionalTimeRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• additionalTimeRange(SearchContactsAdditionalTimeRange)

searchableContactAttributes

SearchCriteria.Builder searchableContactAttributes(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.

searchableContactAttributes

default SearchCriteria.Builder searchableContactAttributes(Consumer<SearchableContactAttributes.Builder> 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.

This is a convenience method that creates an instance of the SearchableContactAttributes.Builder avoiding the need to create one manually via SearchableContactAttributes.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchableContactAttributes(SearchableContactAttributes).

Parameters:

searchableContactAttributes - a consumer that will call methods on SearchableContactAttributes.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• searchableContactAttributes(SearchableContactAttributes)

searchableSegmentAttributes

SearchCriteria.Builder searchableSegmentAttributes(SearchableSegmentAttributes searchableSegmentAttributes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

searchableSegmentAttributes

default SearchCriteria.Builder searchableSegmentAttributes(Consumer<SearchableSegmentAttributes.Builder> searchableSegmentAttributes)

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

This is a convenience method that creates an instance of the SearchableSegmentAttributes.Builder avoiding the need to create one manually via SearchableSegmentAttributes.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchableSegmentAttributes(SearchableSegmentAttributes).

Parameters:

searchableSegmentAttributes - a consumer that will call methods on SearchableSegmentAttributes.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• searchableSegmentAttributes(SearchableSegmentAttributes)