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

Class SpellCorrectedQuery

java.lang.Object

software.amazon.awssdk.services.kendra.model.SpellCorrectedQuery

All Implemented Interfaces:

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

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

A query with suggested spell corrections.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpellCorrectedQuery.Builder

Method Summary

Modifier and Type	Method	Description
static SpellCorrectedQuery.Builder	builder()
List<Correction>	corrections()	The corrected misspelled word or words in a query.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCorrections()	For responses, this returns true if the service returned a value for the Corrections property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SpellCorrectedQuery.Builder>	serializableBuilderClass()
String	suggestedQueryText()	The query with the suggested spell corrections.
SpellCorrectedQuery.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

suggestedQueryText

public final String suggestedQueryText()

The query with the suggested spell corrections.

Returns:

The query with the suggested spell corrections.

hasCorrections

public final boolean hasCorrections()

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

corrections

public final List<Correction> corrections()

The corrected misspelled word or words in a query.

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

Returns:

The corrected misspelled word or words in a query.

toBuilder

public SpellCorrectedQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpellCorrectedQuery.Builder,SpellCorrectedQuery>

builder

public static SpellCorrectedQuery.Builder builder()

serializableBuilderClass

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