Package software.amazon.awssdk.services.kendra.model

Interface Highlight.Builder

All Superinterfaces:

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

Enclosing class:

Highlight

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

Method Summary

Modifier and Type	Method	Description
Highlight.Builder	beginOffset(Integer beginOffset)	The zero-based location in the response string where the highlight starts.
Highlight.Builder	endOffset(Integer endOffset)	The zero-based location in the response string where the highlight ends.
Highlight.Builder	topAnswer(Boolean topAnswer)	Indicates whether the response is the best response.
Highlight.Builder	type(String type)	The highlight type.
Highlight.Builder	type(HighlightType type)	The highlight type.

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 Detail

beginOffset

Highlight.Builder beginOffset(Integer beginOffset)

The zero-based location in the response string where the highlight starts.

Parameters:

beginOffset - The zero-based location in the response string where the highlight starts.

Returns:

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

endOffset

Highlight.Builder endOffset(Integer endOffset)

The zero-based location in the response string where the highlight ends.

Parameters:

endOffset - The zero-based location in the response string where the highlight ends.

Returns:

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

topAnswer

Highlight.Builder topAnswer(Boolean topAnswer)

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Parameters:

topAnswer - Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Returns:

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

type

Highlight.Builder type(String type)

The highlight type.

Parameters:

type - The highlight type.

Returns:

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

See Also:

HighlightType, HighlightType

type

Highlight.Builder type(HighlightType type)

The highlight type.

Parameters:

type - The highlight type.

Returns:

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

See Also:

HighlightType, HighlightType