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

Class TextWithHighlights

java.lang.Object

software.amazon.awssdk.services.kendra.model.TextWithHighlights

All Implemented Interfaces:

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

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

Provides text and information about where to highlight the text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TextWithHighlights.Builder

Method Summary

Modifier and Type	Method	Description
static TextWithHighlights.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHighlights()	For responses, this returns true if the service returned a value for the Highlights property.
List<Highlight>	highlights()	The beginning and end of the text that should be highlighted.
List<SdkField<?>>	sdkFields()
static Class<? extends TextWithHighlights.Builder>	serializableBuilderClass()
String	text()	The text to display to the user.
TextWithHighlights.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

text

public final String text()

The text to display to the user.

Returns:

The text to display to the user.

hasHighlights

public final boolean hasHighlights()

For responses, this returns true if the service returned a value for the Highlights property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

highlights

public final List<Highlight> highlights()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHighlights() method.

Returns:

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

toBuilder

public TextWithHighlights.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TextWithHighlights.Builder,TextWithHighlights>

builder

public static TextWithHighlights.Builder builder()

serializableBuilderClass

public static Class<? extends TextWithHighlights.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