com.amazonaws.services.connect.model

Class SearchUsersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.SearchUsersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchUsersRequest
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
SearchUsersRequest()

Method Summary

Modifier and Type	Method and Description
SearchUsersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getInstanceId() The identifier of the Amazon Connect instance.
Integer	getMaxResults() The maximum number of results to return per page.
String	getNextToken() The token for the next set of results.
UserSearchCriteria	getSearchCriteria()
UserSearchFilter	getSearchFilter() Filters to be applied to search results.
int	hashCode()
void	setInstanceId(String instanceId) The identifier of the 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(UserSearchCriteria searchCriteria)
void	setSearchFilter(UserSearchFilter searchFilter) Filters to be applied to search results.
String	toString() Returns a string representation of this object.
SearchUsersRequest	withInstanceId(String instanceId) The identifier of the Amazon Connect instance.
SearchUsersRequest	withMaxResults(Integer maxResults) The maximum number of results to return per page.
SearchUsersRequest	withNextToken(String nextToken) The token for the next set of results.
SearchUsersRequest	withSearchCriteria(UserSearchCriteria searchCriteria)
SearchUsersRequest	withSearchFilter(UserSearchFilter searchFilter) Filters to be applied 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

SearchUsersRequest

public SearchUsersRequest()

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

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

InstanceID is a required field. The "Required: No" below is incorrect.

Parameters:

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

InstanceID is a required field. The "Required: No" below is incorrect.

getInstanceId

public String getInstanceId()

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

InstanceID is a required field. The "Required: No" below is incorrect.

Returns:

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

InstanceID is a required field. The "Required: No" below is incorrect.

withInstanceId

public SearchUsersRequest withInstanceId(String instanceId)

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

InstanceID is a required field. The "Required: No" below is incorrect.

Parameters:

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

InstanceID is a required field. The "Required: No" below is incorrect.

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 SearchUsersRequest 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.

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 SearchUsersRequest 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.

setSearchFilter

public void setSearchFilter(UserSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

getSearchFilter

public UserSearchFilter getSearchFilter()

Filters to be applied to search results.

Returns:

Filters to be applied to search results.

withSearchFilter

public SearchUsersRequest withSearchFilter(UserSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

Returns:

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

setSearchCriteria

public void setSearchCriteria(UserSearchCriteria searchCriteria)

Parameters:

searchCriteria -

getSearchCriteria

public UserSearchCriteria getSearchCriteria()

Returns:

withSearchCriteria

public SearchUsersRequest withSearchCriteria(UserSearchCriteria searchCriteria)

Parameters:

searchCriteria -

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 SearchUsersRequest 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()