software.amazon.awssdk.services.kendra.model

Class ExpandedResultItem

java.lang.Object

software.amazon.awssdk.services.kendra.model.ExpandedResultItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExpandedResultItem.Builder,ExpandedResultItem>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExpandedResultItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExpandedResultItem.Builder,ExpandedResultItem>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExpandedResultItem.Builder

Method Summary

Modifier and Type	Method and Description
static ExpandedResultItem.Builder	builder()
List<DocumentAttribute>	documentAttributes() An array of document attributes assigned to a document in the search results.
TextWithHighlights	documentExcerpt() Returns the value of the DocumentExcerpt property for this object.
String	documentId() The idenitifier of the document.
TextWithHighlights	documentTitle() Returns the value of the DocumentTitle property for this object.
String	documentURI() The URI of the original location of the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocumentAttributes() For responses, this returns true if the service returned a value for the DocumentAttributes property.
int	hashCode()
String	id() The identifier for the expanded result.
List<SdkField<?>>	sdkFields()
static Class<? extends ExpandedResultItem.Builder>	serializableBuilderClass()
ExpandedResultItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 for the expanded result.

Returns:

The identifier for the expanded result.

documentId

public final String documentId()

The idenitifier of the document.

Returns:

The idenitifier of the 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 URI of the original location of the document.

Returns:

The URI of the original location of the 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 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 document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

toBuilder

public ExpandedResultItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExpandedResultItem.Builder,ExpandedResultItem>

builder

public static ExpandedResultItem.Builder builder()

serializableBuilderClass

public static Class<? extends ExpandedResultItem.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