com.amazonaws.services.connect.model

Class SearchUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.SearchUsersRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchUsersRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Searches users in an Amazon Connect instance, with optional filtering.

AfterContactWorkTimeLimit is returned in milliseconds.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchUsersRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.Integer	getMaxResults() The maximum number of results to return per page.
java.lang.String	getNextToken() The token for the next set of results.
UserSearchCriteria	getSearchCriteria() The search criteria to be used to return users.
UserSearchFilter	getSearchFilter() Filters to be applied to search results.
int	hashCode()
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
void	setNextToken(java.lang.String nextToken) The token for the next set of results.
void	setSearchCriteria(UserSearchCriteria searchCriteria) The search criteria to be used to return users.
void	setSearchFilter(UserSearchFilter searchFilter) Filters to be applied to search results.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SearchUsersRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
SearchUsersRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return per page.
SearchUsersRequest	withNextToken(java.lang.String nextToken) The token for the next set of results.
SearchUsersRequest	withSearchCriteria(UserSearchCriteria searchCriteria) The search criteria to be used to return users.
SearchUsersRequest	withSearchFilter(UserSearchFilter searchFilter) Filters to be applied to search results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchUsersRequest

public SearchUsersRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

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

Constraints:
Length: 1 - 100

Returns:

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

setInstanceId

public void setInstanceId(java.lang.String instanceId)

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

withInstanceId

public SearchUsersRequest withInstanceId(java.lang.String instanceId)

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

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.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.

Constraints:
Length: 1 - 2500

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.

setNextToken

public void setNextToken(java.lang.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.

Constraints:
Length: 1 - 2500

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.

withNextToken

public SearchUsersRequest withNextToken(java.lang.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.

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

Constraints:
Length: 1 - 2500

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:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

Returns:

The maximum number of results to return per page.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

Constraints:
Range: 1 - 100

Parameters:

maxResults -

The maximum number of results to return per page.

withMaxResults

public SearchUsersRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return per page.

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

Constraints:
Range: 1 - 100

Parameters:

maxResults -

The maximum number of results to return per page.

Returns:

A reference to this updated object so that method calls can be chained together.

getSearchFilter

public UserSearchFilter getSearchFilter()

Filters to be applied to search results.

Returns:

Filters to be applied to search results.

setSearchFilter

public void setSearchFilter(UserSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter -

Filters to be applied to search results.

withSearchFilter

public SearchUsersRequest withSearchFilter(UserSearchFilter searchFilter)

Filters to be applied to search results.

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

Parameters:

searchFilter -

Filters to be applied to search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getSearchCriteria

public UserSearchCriteria getSearchCriteria()

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

setSearchCriteria

public void setSearchCriteria(UserSearchCriteria searchCriteria)

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Parameters:

searchCriteria -

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

withSearchCriteria

public SearchUsersRequest withSearchCriteria(UserSearchCriteria searchCriteria)

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

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

Parameters:

searchCriteria -

The search criteria to be used to return users.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object