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

Class Correction

java.lang.Object

software.amazon.awssdk.services.kendra.model.Correction

All Implemented Interfaces:

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

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

A corrected misspelled word in a query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Correction.Builder

Method Summary

Modifier and Type	Method	Description
Integer	beginOffset()	The zero-based location in the response string or text where the corrected word starts.
static Correction.Builder	builder()
String	correctedTerm()	The string or text of a corrected misspelled word in a query.
Integer	endOffset()	The zero-based location in the response string or text where the corrected word ends.
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 Correction.Builder>	serializableBuilderClass()
String	term()	The string or text of a misspelled word in a query.
Correction.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

beginOffset

public final Integer beginOffset()

The zero-based location in the response string or text where the corrected word starts.

Returns:

The zero-based location in the response string or text where the corrected word starts.

endOffset

public final Integer endOffset()

The zero-based location in the response string or text where the corrected word ends.

Returns:

The zero-based location in the response string or text where the corrected word ends.

term

public final String term()

The string or text of a misspelled word in a query.

Returns:

The string or text of a misspelled word in a query.

correctedTerm

public final String correctedTerm()

The string or text of a corrected misspelled word in a query.

Returns:

The string or text of a corrected misspelled word in a query.

toBuilder

public Correction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Correction.Builder,Correction>

builder

public static Correction.Builder builder()

serializableBuilderClass

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