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

Class Suggestion

java.lang.Object

software.amazon.awssdk.services.kendra.model.Suggestion

All Implemented Interfaces:

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

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

A single query suggestion.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Suggestion.Builder

Method Summary

Modifier and Type	Method	Description
static Suggestion.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSourceDocuments()	For responses, this returns true if the service returned a value for the SourceDocuments property.
String	id()	The UUID (universally unique identifier) of a single query suggestion.
List<SdkField<?>>	sdkFields()
static Class<? extends Suggestion.Builder>	serializableBuilderClass()
List<SourceDocument>	sourceDocuments()	The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.
Suggestion.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
SuggestionValue	value()	The value for the UUID (universally unique identifier) of a single query suggestion.

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

id

public final String id()

The UUID (universally unique identifier) of a single query suggestion.

Returns:

The UUID (universally unique identifier) of a single query suggestion.

value

public final SuggestionValue value()

The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

Returns:

The value for the UUID (universally unique identifier) of a single query suggestion.

The value is the text string of a suggestion.

hasSourceDocuments

public final boolean hasSourceDocuments()

For responses, this returns true if the service returned a value for the SourceDocuments 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.

sourceDocuments

public final List<SourceDocument> sourceDocuments()

The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.

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 hasSourceDocuments() method.

Returns:

The list of document IDs and their fields/attributes that are used for a single query suggestion, if document fields set to use for query suggestions.

toBuilder

public Suggestion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Suggestion.Builder,Suggestion>

builder

public static Suggestion.Builder builder()

serializableBuilderClass

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