Package software.amazon.awssdk.services.qconnect.model

Class Highlight

java.lang.Object

software.amazon.awssdk.services.qconnect.model.Highlight

All Implemented Interfaces:

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

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

Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Highlight.Builder

Method Summary

Modifier and Type	Method	Description
Integer	beginOffsetInclusive()	The offset for the start of the highlight.
static Highlight.Builder	builder()
Integer	endOffsetExclusive()	The offset for the end of the highlight.
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()
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

beginOffsetInclusive

public final Integer beginOffsetInclusive()

The offset for the start of the highlight.

Returns:

The offset for the start of the highlight.

endOffsetExclusive

public final Integer endOffsetExclusive()

The offset for the end of the highlight.

Returns:

The offset for the end of the highlight.

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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo