software.amazon.awssdk.services.kendra.model

Interface TextWithHighlights.Builder

All Superinterfaces:

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

Enclosing class:

TextWithHighlights

public static interface TextWithHighlights.Builder
extends SdkPojo, CopyableBuilder<TextWithHighlights.Builder,TextWithHighlights>

Method Summary

Modifier and Type	Method and Description
TextWithHighlights.Builder	highlights(Collection<Highlight> highlights) The beginning and end of the text that should be highlighted.
TextWithHighlights.Builder	highlights(Consumer<Highlight.Builder>... highlights) The beginning and end of the text that should be highlighted.
TextWithHighlights.Builder	highlights(Highlight... highlights) The beginning and end of the text that should be highlighted.
TextWithHighlights.Builder	text(String text) The text to display to the user.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

text

TextWithHighlights.Builder text(String text)

The text to display to the user.

Parameters:

text - The text to display to the user.

Returns:

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

highlights

TextWithHighlights.Builder highlights(Collection<Highlight> highlights)

The beginning and end of the text that should be highlighted.

Parameters:

highlights - The beginning and end of the text that should be highlighted.

Returns:

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

highlights

TextWithHighlights.Builder highlights(Highlight... highlights)

The beginning and end of the text that should be highlighted.

Parameters:

highlights - The beginning and end of the text that should be highlighted.

Returns:

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

highlights

TextWithHighlights.Builder highlights(Consumer<Highlight.Builder>... highlights)

The beginning and end of the text that should be highlighted.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #highlights(List).

Parameters:

highlights - a consumer that will call methods on Highlight.Builder

Returns:

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

See Also:

#highlights(java.util.Collection)