FeaturedResultsItem (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.FeaturedResultsItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FeaturedResultsItem.Builder,FeaturedResultsItem>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class FeaturedResultsItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FeaturedResultsItem.Builder,FeaturedResultsItem>
```
A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FeaturedResultsItem.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FeaturedResultsItem.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalResultAttribute>`	`additionalAttributes()` One or more additional attributes associated with the featured result.
`static FeaturedResultsItem.Builder`	`builder()`
`List<DocumentAttribute>`	`documentAttributes()` An array of document attributes assigned to a featured document in the search results.
`TextWithHighlights`	`documentExcerpt()` Returns the value of the DocumentExcerpt property for this object.
`String`	`documentId()` The identifier of the featured document.
`TextWithHighlights`	`documentTitle()` Returns the value of the DocumentTitle property for this object.
`String`	`documentURI()` The source URI location of the featured document.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`feedbackToken()` A token that identifies a particular featured result from a particular query.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalAttributes()` For responses, this returns true if the service returned a value for the AdditionalAttributes property.
`boolean`	`hasDocumentAttributes()` For responses, this returns true if the service returned a value for the DocumentAttributes property.
`int`	`hashCode()`
`String`	`id()` The identifier of the featured result.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FeaturedResultsItem.Builder>`	`serializableBuilderClass()`
`FeaturedResultsItem.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`QueryResultType`	`type()` The type of document within the featured result response.
`String`	`typeAsString()` The type of document within the featured result response.

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
  - id
```
public final String id()
```
    The identifier of the featured result.
    
    Returns:
    
    The identifier of the featured result.
  - type
```
public final QueryResultType type()
```
    The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
    
    If the service returns an enum value that is not available in the current SDK version, type will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
    
    See Also:
    
    QueryResultType
  - typeAsString
```
public final String typeAsString()
```
    The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
    
    If the service returns an enum value that is not available in the current SDK version, type will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.
    
    See Also:
    
    QueryResultType
  - hasAdditionalAttributes
```
public final boolean hasAdditionalAttributes()
```
    For responses, this returns true if the service returned a value for the AdditionalAttributes 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.
  - additionalAttributes
```
public final List<AdditionalResultAttribute> additionalAttributes()
```
    One or more additional attributes associated with the featured result.
    
    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 hasAdditionalAttributes() method.
    
    Returns:
    
    One or more additional attributes associated with the featured result.
  - documentId
```
public final String documentId()
```
    The identifier of the featured document.
    
    Returns:
    
    The identifier of the featured document.
  - documentTitle
```
public final TextWithHighlights documentTitle()
```
    Returns the value of the DocumentTitle property for this object.
    
    Returns:
    
    The value of the DocumentTitle property for this object.
  - documentExcerpt
```
public final TextWithHighlights documentExcerpt()
```
    Returns the value of the DocumentExcerpt property for this object.
    
    Returns:
    
    The value of the DocumentExcerpt property for this object.
  - documentURI
```
public final String documentURI()
```
    The source URI location of the featured document.
    
    Returns:
    
    The source URI location of the featured document.
  - hasDocumentAttributes
```
public final boolean hasDocumentAttributes()
```
    For responses, this returns true if the service returned a value for the DocumentAttributes 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.
  - documentAttributes
```
public final List<DocumentAttribute> documentAttributes()
```
    An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    
    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 hasDocumentAttributes() method.
    
    Returns:
    
    An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
  - feedbackToken
```
public final String feedbackToken()
```
    A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
    
    Returns:
    
    A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
  - toBuilder
```
public FeaturedResultsItem.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FeaturedResultsItem.Builder,FeaturedResultsItem>
  - builder
```
public static FeaturedResultsItem.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FeaturedResultsItem.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class FeaturedResultsItem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

type

typeAsString

hasAdditionalAttributes

additionalAttributes

documentId

documentTitle

documentExcerpt

documentURI

hasDocumentAttributes

documentAttributes

feedbackToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields