software.amazon.awssdk.services.kendra.model

Class Highlight

java.lang.Object

software.amazon.awssdk.services.kendra.model.Highlight

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Highlight.Builder,Highlight>

@Generated(value="software.amazon.awssdk:codegen")
public final class Highlight
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Highlight.Builder,Highlight>

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Highlight.Builder

Method Summary

Modifier and Type	Method and Description
Integer	beginOffset() The zero-based location in the response string where the highlight starts.
static Highlight.Builder	builder()
Integer	endOffset() The zero-based location in the response string where the highlight ends.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Highlight.Builder>	serializableBuilderClass()
Highlight.Builder	toBuilder()
Boolean	topAnswer() Indicates whether the response is the best response.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

beginOffset

public Integer beginOffset()

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

Returns:

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

endOffset

public Integer endOffset()

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

Returns:

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

topAnswer

public Boolean topAnswer()

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

Returns:

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

toBuilder

public Highlight.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Highlight.Builder,Highlight>

builder

public static Highlight.Builder builder()

serializableBuilderClass

public static Class<? extends Highlight.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo