Interface ExpandedResultItem.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ExpandedResultItem.Builder,
,ExpandedResultItem> SdkBuilder<ExpandedResultItem.Builder,
,ExpandedResultItem> SdkPojo
- Enclosing class:
ExpandedResultItem
-
Method Summary
Modifier and TypeMethodDescriptiondocumentAttributes
(Collection<DocumentAttribute> documentAttributes) An array of document attributes assigned to a document in the search results.documentAttributes
(Consumer<DocumentAttribute.Builder>... documentAttributes) An array of document attributes assigned to a document in the search results.documentAttributes
(DocumentAttribute... documentAttributes) An array of document attributes assigned to a document in the search results.default ExpandedResultItem.Builder
documentExcerpt
(Consumer<TextWithHighlights.Builder> documentExcerpt) Sets the value of the DocumentExcerpt property for this object.documentExcerpt
(TextWithHighlights documentExcerpt) Sets the value of the DocumentExcerpt property for this object.documentId
(String documentId) The idenitifier of the document.default ExpandedResultItem.Builder
documentTitle
(Consumer<TextWithHighlights.Builder> documentTitle) Sets the value of the DocumentTitle property for this object.documentTitle
(TextWithHighlights documentTitle) Sets the value of the DocumentTitle property for this object.documentURI
(String documentURI) The URI of the original location of the document.The identifier for the expanded result.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
documentTitle
Sets the value of the DocumentTitle property for this object.- Parameters:
documentTitle
- The new value for the DocumentTitle property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentTitle
default ExpandedResultItem.Builder documentTitle(Consumer<TextWithHighlights.Builder> documentTitle) Sets the value of the DocumentTitle property for this object. This is a convenience method that creates an instance of theTextWithHighlights.Builder
avoiding the need to create one manually viaTextWithHighlights.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentTitle(TextWithHighlights)
.- Parameters:
documentTitle
- a consumer that will call methods onTextWithHighlights.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
documentExcerpt
Sets the value of the DocumentExcerpt property for this object.- Parameters:
documentExcerpt
- The new value for the DocumentExcerpt property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentExcerpt
default ExpandedResultItem.Builder documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt) Sets the value of the DocumentExcerpt property for this object. This is a convenience method that creates an instance of theTextWithHighlights.Builder
avoiding the need to create one manually viaTextWithHighlights.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentExcerpt(TextWithHighlights)
.- Parameters:
documentExcerpt
- a consumer that will call methods onTextWithHighlights.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
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.
-
documentAttributes
ExpandedResultItem.Builder documentAttributes(Consumer<DocumentAttribute.Builder>... 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.
This is a convenience method that creates an instance of theDocumentAttribute.Builder
avoiding the need to create one manually viaDocumentAttribute.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocumentAttributes(List<DocumentAttribute>)
.- Parameters:
documentAttributes
- a consumer that will call methods onDocumentAttribute.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-