Interface FeaturedResultsItem.Builder

All Superinterfaces:

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

Enclosing class:

FeaturedResultsItem

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

Method Summary

Modifier and Type	Method	Description
FeaturedResultsItem.Builder	additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)	One or more additional attributes associated with the featured result.
FeaturedResultsItem.Builder	additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes)	One or more additional attributes associated with the featured result.
FeaturedResultsItem.Builder	additionalAttributes(AdditionalResultAttribute... additionalAttributes)	One or more additional attributes associated with the featured result.
FeaturedResultsItem.Builder	documentAttributes(Collection<DocumentAttribute> documentAttributes)	An array of document attributes assigned to a featured document in the search results.
FeaturedResultsItem.Builder	documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)	An array of document attributes assigned to a featured document in the search results.
FeaturedResultsItem.Builder	documentAttributes(DocumentAttribute... documentAttributes)	An array of document attributes assigned to a featured document in the search results.
default FeaturedResultsItem.Builder	documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt)	Sets the value of the DocumentExcerpt property for this object.
FeaturedResultsItem.Builder	documentExcerpt(TextWithHighlights documentExcerpt)	Sets the value of the DocumentExcerpt property for this object.
FeaturedResultsItem.Builder	documentId(String documentId)	The identifier of the featured document.
default FeaturedResultsItem.Builder	documentTitle(Consumer<TextWithHighlights.Builder> documentTitle)	Sets the value of the DocumentTitle property for this object.
FeaturedResultsItem.Builder	documentTitle(TextWithHighlights documentTitle)	Sets the value of the DocumentTitle property for this object.
FeaturedResultsItem.Builder	documentURI(String documentURI)	The source URI location of the featured document.
FeaturedResultsItem.Builder	feedbackToken(String feedbackToken)	A token that identifies a particular featured result from a particular query.
FeaturedResultsItem.Builder	id(String id)	The identifier of the featured result.
FeaturedResultsItem.Builder	type(String type)	The type of document within the featured result response.
FeaturedResultsItem.Builder	type(QueryResultType type)	The type of document within the featured result response.

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

FeaturedResultsItem.Builder id(String id)

The identifier of the featured result.

Parameters:

id - The identifier of the featured result.

Returns:

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

type

FeaturedResultsItem.Builder type(String type)

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Parameters:

type - The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Returns:

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

See Also:

• QueryResultType
• QueryResultType

type

FeaturedResultsItem.Builder type(QueryResultType type)

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Parameters:

type - The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Returns:

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

See Also:

• QueryResultType
• QueryResultType

additionalAttributes

FeaturedResultsItem.Builder additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)

One or more additional attributes associated with the featured result.

Parameters:

additionalAttributes - One or more additional attributes associated with the featured result.

Returns:

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

additionalAttributes

FeaturedResultsItem.Builder additionalAttributes(AdditionalResultAttribute... additionalAttributes)

One or more additional attributes associated with the featured result.

Parameters:

additionalAttributes - One or more additional attributes associated with the featured result.

Returns:

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

additionalAttributes

FeaturedResultsItem.Builder additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes)

One or more additional attributes associated with the featured result.

This is a convenience method that creates an instance of the AdditionalResultAttribute.Builder avoiding the need to create one manually via AdditionalResultAttribute.builder().

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

Parameters:

additionalAttributes - a consumer that will call methods on AdditionalResultAttribute.Builder

Returns:

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

See Also:

• additionalAttributes(java.util.Collection<AdditionalResultAttribute>)

documentId

FeaturedResultsItem.Builder documentId(String documentId)

The identifier of the featured document.

Parameters:

documentId - The identifier of the featured document.

Returns:

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

documentTitle

FeaturedResultsItem.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 FeaturedResultsItem.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

FeaturedResultsItem.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 FeaturedResultsItem.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

FeaturedResultsItem.Builder documentURI(String documentURI)

The source URI location of the featured document.

Parameters:

documentURI - The source URI location of the featured document.

Returns:

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

documentAttributes

FeaturedResultsItem.Builder documentAttributes(Collection<DocumentAttribute> documentAttributes)

An array of document attributes assigned to a featured 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 featured 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

FeaturedResultsItem.Builder documentAttributes(DocumentAttribute... documentAttributes)

An array of document attributes assigned to a featured 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 featured 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

FeaturedResultsItem.Builder documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)

An array of document attributes assigned to a featured 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>)

feedbackToken

FeaturedResultsItem.Builder feedbackToken(String feedbackToken)

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Parameters:

feedbackToken - A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Returns:

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