com.amazonaws.services.connect.model

Class SearchContactsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.SearchContactsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchContactsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchContactsRequest()

Method Summary

Modifier and Type	Method and Description
SearchContactsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getInstanceId() The identifier of Amazon Connect instance.
Integer	getMaxResults() The maximum number of results to return per page.
String	getNextToken() The token for the next set of results.
SearchCriteria	getSearchCriteria() The search criteria to be used to return contacts.
Sort	getSort() Specifies a field to sort by and a sort order.
SearchContactsTimeRange	getTimeRange() Time range that you want to search results.
int	hashCode()
void	setInstanceId(String instanceId) The identifier of Amazon Connect instance.
void	setMaxResults(Integer maxResults) The maximum number of results to return per page.
void	setNextToken(String nextToken) The token for the next set of results.
void	setSearchCriteria(SearchCriteria searchCriteria) The search criteria to be used to return contacts.
void	setSort(Sort sort) Specifies a field to sort by and a sort order.
void	setTimeRange(SearchContactsTimeRange timeRange) Time range that you want to search results.
String	toString() Returns a string representation of this object.
SearchContactsRequest	withInstanceId(String instanceId) The identifier of Amazon Connect instance.
SearchContactsRequest	withMaxResults(Integer maxResults) The maximum number of results to return per page.
SearchContactsRequest	withNextToken(String nextToken) The token for the next set of results.
SearchContactsRequest	withSearchCriteria(SearchCriteria searchCriteria) The search criteria to be used to return contacts.
SearchContactsRequest	withSort(Sort sort) Specifies a field to sort by and a sort order.
SearchContactsRequest	withTimeRange(SearchContactsTimeRange timeRange) Time range that you want to search results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchContactsRequest

public SearchContactsRequest()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

getInstanceId

public String getInstanceId()

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

withInstanceId

public SearchContactsRequest withInstanceId(String instanceId)

The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

setTimeRange

public void setTimeRange(SearchContactsTimeRange timeRange)

Time range that you want to search results.

Parameters:

timeRange - Time range that you want to search results.

getTimeRange

public SearchContactsTimeRange getTimeRange()

Time range that you want to search results.

Returns:

Time range that you want to search results.

withTimeRange

public SearchContactsRequest withTimeRange(SearchContactsTimeRange timeRange)

Time range that you want to search results.

Parameters:

timeRange - Time range that you want to search results.

Returns:

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

setSearchCriteria

public void setSearchCriteria(SearchCriteria searchCriteria)

The search criteria to be used to return contacts.

Parameters:

searchCriteria - The search criteria to be used to return contacts.

getSearchCriteria

public SearchCriteria getSearchCriteria()

The search criteria to be used to return contacts.

Returns:

The search criteria to be used to return contacts.

withSearchCriteria

public SearchContactsRequest withSearchCriteria(SearchCriteria searchCriteria)

The search criteria to be used to return contacts.

Parameters:

searchCriteria - The search criteria to be used to return contacts.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

withMaxResults

public SearchContactsRequest withMaxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

getNextToken

public String getNextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

withNextToken

public SearchContactsRequest withNextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

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

setSort

public void setSort(Sort sort)

Specifies a field to sort by and a sort order.

Parameters:

sort - Specifies a field to sort by and a sort order.

getSort

public Sort getSort()

Specifies a field to sort by and a sort order.

Returns:

Specifies a field to sort by and a sort order.

withSort

public SearchContactsRequest withSort(Sort sort)

Specifies a field to sort by and a sort order.

Parameters:

sort - Specifies a field to sort by and a sort order.

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 SearchContactsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()