Class ExpandedResultItem
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ExpandedResultItem.Builder
builder()
final List
<DocumentAttribute> An array of document attributes assigned to a document in the search results.final TextWithHighlights
Returns the value of the DocumentExcerpt property for this object.final String
The idenitifier of the document.final TextWithHighlights
Returns the value of the DocumentTitle property for this object.final String
The URI of the original location of the document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DocumentAttributes property.final int
hashCode()
final String
id()
The identifier for the expanded result.static Class
<? extends ExpandedResultItem.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier for the expanded result.
- Returns:
- The identifier for the expanded result.
-
documentId
The idenitifier of the document.
- Returns:
- The idenitifier of the document.
-
documentTitle
Returns the value of the DocumentTitle property for this object.- Returns:
- The value of the DocumentTitle property for this object.
-
documentExcerpt
Returns the value of the DocumentExcerpt property for this object.- Returns:
- The value of the DocumentExcerpt property for this object.
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExpandedResultItem.Builder,
ExpandedResultItem> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-