java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.kendra.model.KendraRequest
    - - software.amazon.awssdk.services.kendra.model.RetrieveRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RetrieveRequest
extends KendraRequest
implements ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RetrieveRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AttributeFilter`	`attributeFilter()`	Filters search results by document fields/attributes.
`static RetrieveRequest.Builder`	`builder()`
`List<DocumentRelevanceConfiguration>`	`documentRelevanceOverrideConfigurations()`	Overrides relevance tuning configurations of fields/attributes set at the index level.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDocumentRelevanceOverrideConfigurations()`	For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations property.
`int`	`hashCode()`
`boolean`	`hasRequestedDocumentAttributes()`	For responses, this returns true if the service returned a value for the RequestedDocumentAttributes property.
`String`	`indexId()`	The identifier of the index to retrieve relevant passages for the search.
`Integer`	`pageNumber()`	Retrieved relevant passages are returned in pages the size of the `PageSize` parameter.
`Integer`	`pageSize()`	Sets the number of retrieved relevant passages that are returned in each page of results.
`String`	`queryText()`	The input query text to retrieve relevant passages for the search.
`List<String>`	`requestedDocumentAttributes()`	A list of document fields/attributes to include in the response.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RetrieveRequest.Builder>`	`serializableBuilderClass()`
`RetrieveRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UserContext`	`userContext()`	The user context token or user and group information.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - indexId
```
public final String indexId()
```
    The identifier of the index to retrieve relevant passages for the search.
    
    Returns:
    
    The identifier of the index to retrieve relevant passages for the search.
  - queryText
```
public final String queryText()
```
    The input query text to retrieve relevant passages for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
    
    Returns:
    
    The input query text to retrieve relevant passages for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries. For example, Timeoff AND October AND Category:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.
  - attributeFilter
```
public final AttributeFilter attributeFilter()
```
    Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.
    
    The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
    
    Returns:
    
    Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.
    
    The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.
  - hasRequestedDocumentAttributes
```
public final boolean hasRequestedDocumentAttributes()
```
    For responses, this returns true if the service returned a value for the RequestedDocumentAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - requestedDocumentAttributes
```
public final List<String> requestedDocumentAttributes()
```
    A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRequestedDocumentAttributes() method.
    
    Returns:
    
    A list of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document fields are included in the response.
  - hasDocumentRelevanceOverrideConfigurations
```
public final boolean hasDocumentRelevanceOverrideConfigurations()
```
    For responses, this returns true if the service returned a value for the DocumentRelevanceOverrideConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - documentRelevanceOverrideConfigurations
```
public final List<DocumentRelevanceConfiguration> documentRelevanceOverrideConfigurations()
```
    Overrides relevance tuning configurations of fields/attributes set at the index level.
    
    If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
    
    If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDocumentRelevanceOverrideConfigurations() method.
    
    Returns:
    
    Overrides relevance tuning configurations of fields/attributes set at the index level.
    
    If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.
    
    If there is relevance tuning configured for fields at the index level, and you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.
  - pageNumber
```
public final Integer pageNumber()
```
    Retrieved relevant passages 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:
    
    Retrieved relevant passages 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.
  - pageSize
```
public final Integer pageSize()
```
    Sets the number of retrieved relevant passages 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 retrieved relevant passages 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.
  - userContext
```
public final UserContext userContext()
```
    The user context token or user and group information.
    
    Returns:
    
    The user context token or user and group information.
  - toBuilder
```
public RetrieveRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>
    
    Specified by:
    
    toBuilder in class KendraRequest
  - builder
```
public static RetrieveRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RetrieveRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RetrieveRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

indexId

queryText

attributeFilter

hasRequestedDocumentAttributes

requestedDocumentAttributes

hasDocumentRelevanceOverrideConfigurations

documentRelevanceOverrideConfigurations

pageNumber

pageSize

userContext

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields