com.amazonaws.services.alexaforbusiness.model

Class SearchRoomsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.alexaforbusiness.model.SearchRoomsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
SearchRoomsRequest	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 rooms.
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 rooms.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters to use to list a specified set of rooms.
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 rooms.
String	toString() Returns a string representation of this object.
SearchRoomsRequest	withFilters(Collection<Filter> filters) The filters to use to list a specified set of rooms.
SearchRoomsRequest	withFilters(Filter... filters) The filters to use to list a specified set of rooms.
SearchRoomsRequest	withMaxResults(Integer maxResults) The maximum number of results to include in the response.
SearchRoomsRequest	withNextToken(String nextToken) An optional token returned from a prior request.
SearchRoomsRequest	withSortCriteria(Collection<Sort> sortCriteria) The sort order to use in listing the specified set of rooms.
SearchRoomsRequest	withSortCriteria(Sort... sortCriteria) The sort order to use in listing the specified set of rooms.

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

SearchRoomsRequest

public SearchRoomsRequest()

Method Detail

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 includes only 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 includes only 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 includes only 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 includes only results beyond the token, up to the value specified by MaxResults.

withNextToken

public SearchRoomsRequest 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 includes only 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 includes only 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 SearchRoomsRequest 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.

getFilters

public List<Filter> getFilters()

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

Returns:

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

setFilters

public void setFilters(Collection<Filter> filters)

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

Parameters:

filters - The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

withFilters

public SearchRoomsRequest withFilters(Filter... filters)

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

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 rooms. The supported filter keys are RoomName and ProfileName.

Returns:

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

withFilters

public SearchRoomsRequest withFilters(Collection<Filter> filters)

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

Parameters:

filters - The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

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 rooms. The supported sort keys are RoomName and ProfileName.

Returns:

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

setSortCriteria

public void setSortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

withSortCriteria

public SearchRoomsRequest withSortCriteria(Sort... sortCriteria)

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

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 rooms. The supported sort keys are RoomName and ProfileName.

Returns:

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

withSortCriteria

public SearchRoomsRequest withSortCriteria(Collection<Sort> sortCriteria)

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

Parameters:

sortCriteria - The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

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