com.amazonaws.services.iot.model

Class SearchIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.SearchIndexRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchIndexRequest()

Method Summary

Modifier and Type	Method and Description
SearchIndexRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIndexName() The search index name.
Integer	getMaxResults() The maximum number of results to return per page at one time.
String	getNextToken() The token used to get the next set of results, or null if there are no additional results.
String	getQueryString() The search query string.
String	getQueryVersion() The query version.
int	hashCode()
void	setIndexName(String indexName) The search index name.
void	setMaxResults(Integer maxResults) The maximum number of results to return per page at one time.
void	setNextToken(String nextToken) The token used to get the next set of results, or null if there are no additional results.
void	setQueryString(String queryString) The search query string.
void	setQueryVersion(String queryVersion) The query version.
String	toString() Returns a string representation of this object.
SearchIndexRequest	withIndexName(String indexName) The search index name.
SearchIndexRequest	withMaxResults(Integer maxResults) The maximum number of results to return per page at one time.
SearchIndexRequest	withNextToken(String nextToken) The token used to get the next set of results, or null if there are no additional results.
SearchIndexRequest	withQueryString(String queryString) The search query string.
SearchIndexRequest	withQueryVersion(String queryVersion) The query version.

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

SearchIndexRequest

public SearchIndexRequest()

Method Detail

setIndexName

public void setIndexName(String indexName)

The search index name.

Parameters:

indexName - The search index name.

getIndexName

public String getIndexName()

The search index name.

Returns:

The search index name.

withIndexName

public SearchIndexRequest withIndexName(String indexName)

The search index name.

Parameters:

indexName - The search index name.

Returns:

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

setQueryString

public void setQueryString(String queryString)

The search query string. For more information about the search query syntax, see Query syntax.

Parameters:

queryString - The search query string. For more information about the search query syntax, see Query syntax.

getQueryString

public String getQueryString()

The search query string. For more information about the search query syntax, see Query syntax.

Returns:

The search query string. For more information about the search query syntax, see Query syntax.

withQueryString

public SearchIndexRequest withQueryString(String queryString)

The search query string. For more information about the search query syntax, see Query syntax.

Parameters:

queryString - The search query string. For more information about the search query syntax, see Query syntax.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token used to get the next set of results, or null if there are no additional results.

Parameters:

nextToken - The token used to get the next set of results, or null if there are no additional results.

getNextToken

public String getNextToken()

The token used to get the next set of results, or null if there are no additional results.

Returns:

The token used to get the next set of results, or null if there are no additional results.

withNextToken

public SearchIndexRequest withNextToken(String nextToken)

The token used to get the next set of results, or null if there are no additional results.

Parameters:

nextToken - The token used to get the next set of results, or null if there are no additional 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 at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Parameters:

maxResults - The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Returns:

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

withMaxResults

public SearchIndexRequest withMaxResults(Integer maxResults)

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Parameters:

maxResults - The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Returns:

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

setQueryVersion

public void setQueryVersion(String queryVersion)

The query version.

Parameters:

queryVersion - The query version.

getQueryVersion

public String getQueryVersion()

The query version.

Returns:

The query version.

withQueryVersion

public SearchIndexRequest withQueryVersion(String queryVersion)

The query version.

Parameters:

queryVersion - The query version.

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