ExpandedResultItem (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExpandedResultItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A single expanded result in a collapsed group of search results.

An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExpandedResultItem()

Constructors
Constructor and Description
`ExpandedResultItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExpandedResultItem`	`clone()`
`boolean`	`equals(Object obj)`
`List<DocumentAttribute>`	`getDocumentAttributes()` An array of document attributes assigned to a document in the search results.
`TextWithHighlights`	`getDocumentExcerpt()`
`String`	`getDocumentId()` The idenitifier of the document.
`TextWithHighlights`	`getDocumentTitle()`
`String`	`getDocumentURI()` The URI of the original location of the document.
`String`	`getId()` The identifier for the expanded result.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentAttributes(Collection<DocumentAttribute> documentAttributes)` An array of document attributes assigned to a document in the search results.
`void`	`setDocumentExcerpt(TextWithHighlights documentExcerpt)`
`void`	`setDocumentId(String documentId)` The idenitifier of the document.
`void`	`setDocumentTitle(TextWithHighlights documentTitle)`
`void`	`setDocumentURI(String documentURI)` The URI of the original location of the document.
`void`	`setId(String id)` The identifier for the expanded result.
`String`	`toString()` Returns a string representation of this object.
`ExpandedResultItem`	`withDocumentAttributes(Collection<DocumentAttribute> documentAttributes)` An array of document attributes assigned to a document in the search results.
`ExpandedResultItem`	`withDocumentAttributes(DocumentAttribute... documentAttributes)` An array of document attributes assigned to a document in the search results.
`ExpandedResultItem`	`withDocumentExcerpt(TextWithHighlights documentExcerpt)`
`ExpandedResultItem`	`withDocumentId(String documentId)` The idenitifier of the document.
`ExpandedResultItem`	`withDocumentTitle(TextWithHighlights documentTitle)`
`ExpandedResultItem`	`withDocumentURI(String documentURI)` The URI of the original location of the document.
`ExpandedResultItem`	`withId(String id)` The identifier for the expanded result.

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

- Constructor Detail
  - ExpandedResultItem
```
public ExpandedResultItem()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The identifier for the expanded result.
    
    Parameters:
    
    id - The identifier for the expanded result.
  - getId
```
public String getId()
```
    The identifier for the expanded result.
    
    Returns:
    
    The identifier for the expanded result.
  - withId
```
public ExpandedResultItem withId(String id)
```
    The identifier for the expanded result.
    
    Parameters:
    
    id - The identifier for the expanded result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentId
```
public void setDocumentId(String documentId)
```
    The idenitifier of the document.
    
    Parameters:
    
    documentId - The idenitifier of the document.
  - getDocumentId
```
public String getDocumentId()
```
    The idenitifier of the document.
    
    Returns:
    
    The idenitifier of the document.
  - withDocumentId
```
public ExpandedResultItem withDocumentId(String documentId)
```
    The idenitifier of the document.
    
    Parameters:
    
    documentId - The idenitifier of the 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 ExpandedResultItem 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 ExpandedResultItem 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 URI of the original location of the document.
    
    Parameters:
    
    documentURI - The URI of the original location of the document.
  - getDocumentURI
```
public String getDocumentURI()
```
    The URI of the original location of the document.
    
    Returns:
    
    The URI of the original location of the document.
  - withDocumentURI
```
public ExpandedResultItem withDocumentURI(String documentURI)
```
    The URI of the original location of the document.
    
    Parameters:
    
    documentURI - The URI of the original location of the 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 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 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 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 document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.
  - withDocumentAttributes
```
public ExpandedResultItem withDocumentAttributes(DocumentAttribute... documentAttributes)
```
    An array of document attributes assigned to a 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 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 ExpandedResultItem withDocumentAttributes(Collection<DocumentAttribute> documentAttributes)
```
    An array of document attributes assigned to a 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 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.
  - 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 ExpandedResultItem 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.782

Class ExpandedResultItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExpandedResultItem

Method Detail

setId

getId

withId

setDocumentId

getDocumentId

withDocumentId

setDocumentTitle

getDocumentTitle

withDocumentTitle

setDocumentExcerpt

getDocumentExcerpt

withDocumentExcerpt

setDocumentURI

getDocumentURI

withDocumentURI

getDocumentAttributes

setDocumentAttributes

withDocumentAttributes

withDocumentAttributes

toString

equals

hashCode

clone

marshall