com.amazonaws.services.iot.model

Class SearchIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.SearchIndexRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SearchIndexRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

The query search index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchIndexRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchIndexRequest

public SearchIndexRequest()

Method Detail

getIndexName

public java.lang.String getIndexName()

The search index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Returns:

The search index name.

setIndexName

public void setIndexName(java.lang.String indexName)

The search index name.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

indexName -

The search index name.

withIndexName

public SearchIndexRequest withIndexName(java.lang.String indexName)

The search index name.

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+

Parameters:

indexName -

The search index name.

Returns:

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

getQueryString

public java.lang.String getQueryString()

The search query string.

Constraints:
Length: 1 -

Returns:

The search query string.

setQueryString

public void setQueryString(java.lang.String queryString)

The search query string.

Constraints:
Length: 1 -

Parameters:

queryString -

The search query string.

withQueryString

public SearchIndexRequest withQueryString(java.lang.String queryString)

The search query string.

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

Constraints:
Length: 1 -

Parameters:

queryString -

The search query string.

Returns:

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

getNextToken

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

setNextToken

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

withNextToken

public SearchIndexRequest withNextToken(java.lang.String nextToken)

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

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

Parameters:

nextToken -

The token used to get the next set of results, or null if there are no additional 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 at one time.

Constraints:
Range: 1 - 500

Returns:

The maximum number of results to return at one time.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of results to return at one time.

Constraints:
Range: 1 - 500

Parameters:

maxResults -

The maximum number of results to return at one time.

withMaxResults

public SearchIndexRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of results to return at one time.

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

Constraints:
Range: 1 - 500

Parameters:

maxResults -

The maximum number of results to return at one time.

Returns:

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

getQueryVersion

public java.lang.String getQueryVersion()

The query version.

Returns:

The query version.

setQueryVersion

public void setQueryVersion(java.lang.String queryVersion)

The query version.

Parameters:

queryVersion -

The query version.

withQueryVersion

public SearchIndexRequest withQueryVersion(java.lang.String queryVersion)

The query version.

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

Parameters:

queryVersion -

The query version.

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