FeaturedResultsItem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.FeaturedResultsItem

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FeaturedResultsItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

FeaturedResultsItem()

Constructors
Constructor and Description
`FeaturedResultsItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FeaturedResultsItem`	`clone()`
`boolean`	`equals(Object obj)`
`List<AdditionalResultAttribute>`	`getAdditionalAttributes()` One or more additional attributes associated with the featured result.
`List<DocumentAttribute>`	`getDocumentAttributes()` An array of document attributes assigned to a featured document in the search results.
`TextWithHighlights`	`getDocumentExcerpt()`
`String`	`getDocumentId()` The identifier of the featured document.
`TextWithHighlights`	`getDocumentTitle()`
`String`	`getDocumentURI()` The source URI location of the featured document.
`String`	`getFeedbackToken()` A token that identifies a particular featured result from a particular query.
`String`	`getId()` The identifier of the featured result.
`String`	`getType()` The type of document within the featured result response.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)` One or more additional attributes associated with the featured result.
`void`	`setDocumentAttributes(Collection<DocumentAttribute> documentAttributes)` An array of document attributes assigned to a featured document in the search results.
`void`	`setDocumentExcerpt(TextWithHighlights documentExcerpt)`
`void`	`setDocumentId(String documentId)` The identifier of the featured document.
`void`	`setDocumentTitle(TextWithHighlights documentTitle)`
`void`	`setDocumentURI(String documentURI)` The source URI location of the featured document.
`void`	`setFeedbackToken(String feedbackToken)` A token that identifies a particular featured result from a particular query.
`void`	`setId(String id)` The identifier of the featured result.
`void`	`setType(String type)` The type of document within the featured result response.
`String`	`toString()` Returns a string representation of this object.
`FeaturedResultsItem`	`withAdditionalAttributes(AdditionalResultAttribute... additionalAttributes)` One or more additional attributes associated with the featured result.
`FeaturedResultsItem`	`withAdditionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)` One or more additional attributes associated with the featured result.
`FeaturedResultsItem`	`withDocumentAttributes(Collection<DocumentAttribute> documentAttributes)` An array of document attributes assigned to a featured document in the search results.
`FeaturedResultsItem`	`withDocumentAttributes(DocumentAttribute... documentAttributes)` An array of document attributes assigned to a featured document in the search results.
`FeaturedResultsItem`	`withDocumentExcerpt(TextWithHighlights documentExcerpt)`
`FeaturedResultsItem`	`withDocumentId(String documentId)` The identifier of the featured document.
`FeaturedResultsItem`	`withDocumentTitle(TextWithHighlights documentTitle)`
`FeaturedResultsItem`	`withDocumentURI(String documentURI)` The source URI location of the featured document.
`FeaturedResultsItem`	`withFeedbackToken(String feedbackToken)` A token that identifies a particular featured result from a particular query.
`FeaturedResultsItem`	`withId(String id)` The identifier of the featured result.
`FeaturedResultsItem`	`withType(QueryResultType type)` The type of document within the featured result response.
`FeaturedResultsItem`	`withType(String type)` The type of document within the featured result response.

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

- Constructor Detail
  - FeaturedResultsItem
```
public FeaturedResultsItem()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier of the featured result.
    
    Parameters:
    
    id - The identifier of the featured result.
  - getId
```
public String getId()
```
    The identifier of the featured result.
    
    Returns:
    
    The identifier of the featured result.
  - withId
```
public FeaturedResultsItem withId(String id)
```
    The identifier of the featured result.
    
    Parameters:
    
    id - The identifier of the featured result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    QueryResultType
  - getType
```
public String getType()
```
    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.
    
    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
  - withType
```
public FeaturedResultsItem withType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultType
  - withType
```
public FeaturedResultsItem withType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultType
  - getAdditionalAttributes
```
public List<AdditionalResultAttribute> getAdditionalAttributes()
```
    One or more additional attributes associated with the featured result.
    
    Returns:
    
    One or more additional attributes associated with the featured result.
  - setAdditionalAttributes
```
public void setAdditionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)
```
    One or more additional attributes associated with the featured result.
    
    Parameters:
    
    additionalAttributes - One or more additional attributes associated with the featured result.
  - withAdditionalAttributes
```
public FeaturedResultsItem withAdditionalAttributes(AdditionalResultAttribute... additionalAttributes)
```
    One or more additional attributes associated with the featured result.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalAttributes(java.util.Collection) or withAdditionalAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalAttributes - One or more additional attributes associated with the featured result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalAttributes
```
public FeaturedResultsItem withAdditionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)
```
    One or more additional attributes associated with the featured result.
    
    Parameters:
    
    additionalAttributes - One or more additional attributes associated with the featured result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentId
```
public void setDocumentId(String documentId)
```
    The identifier of the featured document.
    
    Parameters:
    
    documentId - The identifier of the featured document.
  - getDocumentId
```
public String getDocumentId()
```
    The identifier of the featured document.
    
    Returns:
    
    The identifier of the featured document.
  - withDocumentId
```
public FeaturedResultsItem withDocumentId(String documentId)
```
    The identifier of the featured document.
    
    Parameters:
    
    documentId - The identifier of the featured document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentTitle
```
public void setDocumentTitle(TextWithHighlights documentTitle)
```
    Parameters:
    
    documentTitle -
  - getDocumentTitle
```
public TextWithHighlights getDocumentTitle()
```
    Returns:
  - withDocumentTitle
```
public FeaturedResultsItem withDocumentTitle(TextWithHighlights documentTitle)
```
    Parameters:
    
    documentTitle -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentExcerpt
```
public void setDocumentExcerpt(TextWithHighlights documentExcerpt)
```
    Parameters:
    
    documentExcerpt -
  - getDocumentExcerpt
```
public TextWithHighlights getDocumentExcerpt()
```
    Returns:
  - withDocumentExcerpt
```
public FeaturedResultsItem withDocumentExcerpt(TextWithHighlights documentExcerpt)
```
    Parameters:
    
    documentExcerpt -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentURI
```
public void setDocumentURI(String documentURI)
```
    The source URI location of the featured document.
    
    Parameters:
    
    documentURI - The source URI location of the featured document.
  - getDocumentURI
```
public String getDocumentURI()
```
    The source URI location of the featured document.
    
    Returns:
    
    The source URI location of the featured document.
  - withDocumentURI
```
public FeaturedResultsItem withDocumentURI(String documentURI)
```
    The source URI location of the featured document.
    
    Parameters:
    
    documentURI - The source URI location of the featured document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDocumentAttributes
```
public List<DocumentAttribute> getDocumentAttributes()
```
    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.
    
    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.
  - setDocumentAttributes
```
public void setDocumentAttributes(Collection<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.
    
    Parameters:
    
    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.
  - withDocumentAttributes
```
public FeaturedResultsItem withDocumentAttributes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDocumentAttributes(java.util.Collection) or withDocumentAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDocumentAttributes
```
public FeaturedResultsItem withDocumentAttributes(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFeedbackToken
```
public void setFeedbackToken(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.
    
    Parameters:
    
    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.
  - getFeedbackToken
```
public String getFeedbackToken()
```
    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.
  - withFeedbackToken
```
public FeaturedResultsItem withFeedbackToken(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.
    
    Parameters:
    
    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:
    
    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 FeaturedResultsItem clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class FeaturedResultsItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FeaturedResultsItem

Method Detail

setId

getId

withId

setType

getType

withType

withType

getAdditionalAttributes

setAdditionalAttributes

withAdditionalAttributes

withAdditionalAttributes

setDocumentId

getDocumentId

withDocumentId

setDocumentTitle

getDocumentTitle

withDocumentTitle

setDocumentExcerpt

getDocumentExcerpt

withDocumentExcerpt

setDocumentURI

getDocumentURI

withDocumentURI

getDocumentAttributes

setDocumentAttributes

withDocumentAttributes

withDocumentAttributes

setFeedbackToken

getFeedbackToken

withFeedbackToken

toString

equals

hashCode

clone

marshall