com.amazonaws.services.kendra.model

Class QueryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kendra.model.QueryRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
QueryRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AttributeFilter	getAttributeFilter() Enables filtered searches based on document attributes.
List<Facet>	getFacets() An array of documents attributes.
String	getIndexId() The unique identifier of the index to search.
Integer	getPageNumber() Query results are returned in pages the size of the PageSize parameter.
Integer	getPageSize() Sets the number of results that are returned in each page of results.
String	getQueryResultTypeFilter() Sets the type of query.
String	getQueryText() The text to search for.
List<String>	getRequestedDocumentAttributes() An array of document attributes to include in the response.
int	hashCode()
void	setAttributeFilter(AttributeFilter attributeFilter) Enables filtered searches based on document attributes.
void	setFacets(Collection<Facet> facets) An array of documents attributes.
void	setIndexId(String indexId) The unique identifier of the index to search.
void	setPageNumber(Integer pageNumber) Query results are returned in pages the size of the PageSize parameter.
void	setPageSize(Integer pageSize) Sets the number of results that are returned in each page of results.
void	setQueryResultTypeFilter(String queryResultTypeFilter) Sets the type of query.
void	setQueryText(String queryText) The text to search for.
void	setRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes) An array of document attributes to include in the response.
String	toString() Returns a string representation of this object.
QueryRequest	withAttributeFilter(AttributeFilter attributeFilter) Enables filtered searches based on document attributes.
QueryRequest	withFacets(Collection<Facet> facets) An array of documents attributes.
QueryRequest	withFacets(Facet... facets) An array of documents attributes.
QueryRequest	withIndexId(String indexId) The unique identifier of the index to search.
QueryRequest	withPageNumber(Integer pageNumber) Query results are returned in pages the size of the PageSize parameter.
QueryRequest	withPageSize(Integer pageSize) Sets the number of results that are returned in each page of results.
QueryRequest	withQueryResultTypeFilter(QueryResultType queryResultTypeFilter) Sets the type of query.
QueryRequest	withQueryResultTypeFilter(String queryResultTypeFilter) Sets the type of query.
QueryRequest	withQueryText(String queryText) The text to search for.
QueryRequest	withRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes) An array of document attributes to include in the response.
QueryRequest	withRequestedDocumentAttributes(String... requestedDocumentAttributes) An array of document attributes to include in the response.

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

QueryRequest

public QueryRequest()

Method Detail

setIndexId

public void setIndexId(String indexId)

The unique identifier of the index to search. The identifier is returned in the response from the operation.

Parameters:

indexId - The unique identifier of the index to search. The identifier is returned in the response from the operation.

getIndexId

public String getIndexId()

The unique identifier of the index to search. The identifier is returned in the response from the operation.

Returns:

The unique identifier of the index to search. The identifier is returned in the response from the operation.

withIndexId

public QueryRequest withIndexId(String indexId)

The unique identifier of the index to search. The identifier is returned in the response from the operation.

Parameters:

indexId - The unique identifier of the index to search. The identifier is returned in the response from the operation.

Returns:

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

setQueryText

public void setQueryText(String queryText)

The text to search for.

Parameters:

queryText - The text to search for.

getQueryText

public String getQueryText()

The text to search for.

Returns:

The text to search for.

withQueryText

public QueryRequest withQueryText(String queryText)

The text to search for.

Parameters:

queryText - The text to search for.

Returns:

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

setAttributeFilter

public void setAttributeFilter(AttributeFilter attributeFilter)

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Parameters:

attributeFilter - Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

getAttributeFilter

public AttributeFilter getAttributeFilter()

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Returns:

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

withAttributeFilter

public QueryRequest withAttributeFilter(AttributeFilter attributeFilter)

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Parameters:

attributeFilter - Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Returns:

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

getFacets

public List<Facet> getFacets()

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Returns:

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

setFacets

public void setFacets(Collection<Facet> facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Parameters:

facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

withFacets

public QueryRequest withFacets(Facet... facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

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

Parameters:

facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Returns:

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

withFacets

public QueryRequest withFacets(Collection<Facet> facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Parameters:

facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Returns:

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

getRequestedDocumentAttributes

public List<String> getRequestedDocumentAttributes()

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Returns:

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

setRequestedDocumentAttributes

public void setRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes)

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Parameters:

requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

withRequestedDocumentAttributes

public QueryRequest withRequestedDocumentAttributes(String... requestedDocumentAttributes)

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

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

Parameters:

requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Returns:

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

withRequestedDocumentAttributes

public QueryRequest withRequestedDocumentAttributes(Collection<String> requestedDocumentAttributes)

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Parameters:

requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Returns:

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

setQueryResultTypeFilter

public void setQueryResultTypeFilter(String queryResultTypeFilter)

Sets the type of query. Only results for the specified query type are returned.

Parameters:

queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

See Also:

QueryResultType

getQueryResultTypeFilter

public String getQueryResultTypeFilter()

Sets the type of query. Only results for the specified query type are returned.

Returns:

Sets the type of query. Only results for the specified query type are returned.

See Also:

QueryResultType

withQueryResultTypeFilter

public QueryRequest withQueryResultTypeFilter(String queryResultTypeFilter)

Sets the type of query. Only results for the specified query type are returned.

Parameters:

queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

Returns:

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

See Also:

QueryResultType

withQueryResultTypeFilter

public QueryRequest withQueryResultTypeFilter(QueryResultType queryResultTypeFilter)

Sets the type of query. Only results for the specified query type are returned.

Parameters:

queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

Returns:

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

See Also:

QueryResultType

setPageNumber

public void setPageNumber(Integer pageNumber)

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Parameters:

pageNumber - Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

getPageNumber

public Integer getPageNumber()

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Returns:

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

withPageNumber

public QueryRequest withPageNumber(Integer pageNumber)

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Parameters:

pageNumber - Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Returns:

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

setPageSize

public void setPageSize(Integer pageSize)

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Parameters:

pageSize - Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

getPageSize

public Integer getPageSize()

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Returns:

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

withPageSize

public QueryRequest withPageSize(Integer pageSize)

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Parameters:

pageSize - Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

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