com.amazonaws.services.alexaforbusiness.model

Class SearchAddressBooksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.alexaforbusiness.model.SearchAddressBooksRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
SearchAddressBooksRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Filter>	getFilters() The filters to use to list a specified set of address books.
Integer	getMaxResults() The maximum number of results to include in the response.
String	getNextToken() An optional token returned from a prior request.
List<Sort>	getSortCriteria() The sort order to use in listing the specified set of address books.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters to use to list a specified set of address books.
void	setMaxResults(Integer maxResults) The maximum number of results to include in the response.
void	setNextToken(String nextToken) An optional token returned from a prior request.
void	setSortCriteria(Collection<Sort> sortCriteria) The sort order to use in listing the specified set of address books.
String	toString() Returns a string representation of this object.
SearchAddressBooksRequest	withFilters(Collection<Filter> filters) The filters to use to list a specified set of address books.
SearchAddressBooksRequest	withFilters(Filter... filters) The filters to use to list a specified set of address books.
SearchAddressBooksRequest	withMaxResults(Integer maxResults) The maximum number of results to include in the response.
SearchAddressBooksRequest	withNextToken(String nextToken) An optional token returned from a prior request.
SearchAddressBooksRequest	withSortCriteria(Collection<Sort> sortCriteria) The sort order to use in listing the specified set of address books.
SearchAddressBooksRequest	withSortCriteria(Sort... sortCriteria) The sort order to use in listing the specified set of address books.

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

SearchAddressBooksRequest

public SearchAddressBooksRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Returns:

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

setFilters

public void setFilters(Collection<Filter> filters)

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Parameters:

filters - The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

withFilters

public SearchAddressBooksRequest withFilters(Filter... filters)

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Returns:

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

withFilters

public SearchAddressBooksRequest withFilters(Collection<Filter> filters)

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Parameters:

filters - The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

Returns:

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

getSortCriteria

public List<Sort> getSortCriteria()

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Returns:

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

setSortCriteria

public void setSortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

withSortCriteria

public SearchAddressBooksRequest withSortCriteria(Sort... sortCriteria)

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

NOTE: This method appends the values to the existing list (if any). Use setSortCriteria(java.util.Collection) or withSortCriteria(java.util.Collection) if you want to override the existing values.

Parameters:

sortCriteria - The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Returns:

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

withSortCriteria

public SearchAddressBooksRequest withSortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

getNextToken

public String getNextToken()

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Returns:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

withNextToken

public SearchAddressBooksRequest withNextToken(String nextToken)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Parameters:

nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

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 include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

getMaxResults

public Integer getMaxResults()

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

withMaxResults

public SearchAddressBooksRequest withMaxResults(Integer maxResults)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Parameters:

maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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