software.amazon.awssdk.services.kendra.model

Class SuggestionTextWithHighlights

java.lang.Object

software.amazon.awssdk.services.kendra.model.SuggestionTextWithHighlights

All Implemented Interfaces:

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

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

Provides text and information about where to highlight the query suggestion text.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SuggestionTextWithHighlights.Builder

Method Summary

Modifier and Type	Method and Description
static SuggestionTextWithHighlights.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHighlights() Returns true if the Highlights property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SuggestionHighlight>	highlights() The beginning and end of the query suggestion text that should be highlighted.
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestionTextWithHighlights.Builder>	serializableBuilderClass()
String	text() The query suggestion text to display to the user.
SuggestionTextWithHighlights.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 query suggestion text to display to the user.

Returns:

The query suggestion text to display to the user.

hasHighlights

public final boolean hasHighlights()

Returns true if the Highlights property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

highlights

public final List<SuggestionHighlight> highlights()

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

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

You can use hasHighlights() to see if a value was sent in this field.

Returns:

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

toBuilder

public SuggestionTextWithHighlights.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestionTextWithHighlights.Builder,SuggestionTextWithHighlights>

builder

public static SuggestionTextWithHighlights.Builder builder()

serializableBuilderClass

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