Interface ExpandedResultItem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ExpandedResultItem.Builder,ExpandedResultItem>, SdkBuilder<ExpandedResultItem.Builder,ExpandedResultItem>, SdkPojo

Enclosing class:

ExpandedResultItem

@Mutable
@NotThreadSafe
public static interface ExpandedResultItem.Builder
extends SdkPojo, CopyableBuilder<ExpandedResultItem.Builder,ExpandedResultItem>

Method Summary

Modifier and Type	Method	Description
ExpandedResultItem.Builder	documentAttributes(Collection<DocumentAttribute> documentAttributes)	An array of document attributes assigned to a document in the search results.
ExpandedResultItem.Builder	documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)	An array of document attributes assigned to a document in the search results.
ExpandedResultItem.Builder	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.
ExpandedResultItem.Builder	documentExcerpt(TextWithHighlights documentExcerpt)	Sets the value of the DocumentExcerpt property for this object.
ExpandedResultItem.Builder	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.
ExpandedResultItem.Builder	documentTitle(TextWithHighlights documentTitle)	Sets the value of the DocumentTitle property for this object.
ExpandedResultItem.Builder	documentURI(String documentURI)	The URI of the original location of the document.
ExpandedResultItem.Builder	id(String id)	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, sdkFieldNameToField, sdkFields

Method Details

id

ExpandedResultItem.Builder id(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.

documentId

ExpandedResultItem.Builder documentId(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.

documentTitle

ExpandedResultItem.Builder documentTitle(TextWithHighlights 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 the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentTitle(TextWithHighlights).

Parameters:

documentTitle - a consumer that will call methods on TextWithHighlights.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentTitle(TextWithHighlights)

documentExcerpt

ExpandedResultItem.Builder documentExcerpt(TextWithHighlights 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 the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentExcerpt(TextWithHighlights).

Parameters:

documentExcerpt - a consumer that will call methods on TextWithHighlights.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentExcerpt(TextWithHighlights)

documentURI

ExpandedResultItem.Builder documentURI(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.

documentAttributes

ExpandedResultItem.Builder documentAttributes(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.

documentAttributes

ExpandedResultItem.Builder documentAttributes(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.

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 the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentAttributes(List<DocumentAttribute>).

Parameters:

documentAttributes - a consumer that will call methods on DocumentAttribute.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documentAttributes(java.util.Collection<DocumentAttribute>)