com.amazonaws.services.kendra.model

Class SpellCorrectedQuery

java.lang.Object

com.amazonaws.services.kendra.model.SpellCorrectedQuery

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SpellCorrectedQuery
extends Object
implements Serializable, Cloneable, StructuredPojo

A query with suggested spell corrections.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpellCorrectedQuery()

Method Summary

Modifier and Type	Method and Description
SpellCorrectedQuery	clone()
boolean	equals(Object obj)
List<Correction>	getCorrections() The corrected misspelled word or words in a query.
String	getSuggestedQueryText() The query with the suggested spell corrections.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCorrections(Collection<Correction> corrections) The corrected misspelled word or words in a query.
void	setSuggestedQueryText(String suggestedQueryText) The query with the suggested spell corrections.
String	toString() Returns a string representation of this object.
SpellCorrectedQuery	withCorrections(Collection<Correction> corrections) The corrected misspelled word or words in a query.
SpellCorrectedQuery	withCorrections(Correction... corrections) The corrected misspelled word or words in a query.
SpellCorrectedQuery	withSuggestedQueryText(String suggestedQueryText) The query with the suggested spell corrections.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpellCorrectedQuery

public SpellCorrectedQuery()

Method Detail

setSuggestedQueryText

public void setSuggestedQueryText(String suggestedQueryText)

The query with the suggested spell corrections.

Parameters:

suggestedQueryText - The query with the suggested spell corrections.

getSuggestedQueryText

public String getSuggestedQueryText()

The query with the suggested spell corrections.

Returns:

The query with the suggested spell corrections.

withSuggestedQueryText

public SpellCorrectedQuery withSuggestedQueryText(String suggestedQueryText)

The query with the suggested spell corrections.

Parameters:

suggestedQueryText - The query with the suggested spell corrections.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCorrections

public List<Correction> getCorrections()

The corrected misspelled word or words in a query.

Returns:

The corrected misspelled word or words in a query.

setCorrections

public void setCorrections(Collection<Correction> corrections)

The corrected misspelled word or words in a query.

Parameters:

corrections - The corrected misspelled word or words in a query.

withCorrections

public SpellCorrectedQuery withCorrections(Correction... corrections)

The corrected misspelled word or words in a query.

NOTE: This method appends the values to the existing list (if any). Use setCorrections(java.util.Collection) or withCorrections(java.util.Collection) if you want to override the existing values.

Parameters:

corrections - The corrected misspelled word or words in a query.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCorrections

public SpellCorrectedQuery withCorrections(Collection<Correction> corrections)

The corrected misspelled word or words in a query.

Parameters:

corrections - The corrected misspelled word or words in a query.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SpellCorrectedQuery clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.