com.amazonaws.services.kendra.model

Class Suggestion

java.lang.Object

com.amazonaws.services.kendra.model.Suggestion

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A single query suggestion.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Suggestion()

Method Summary

Modifier and Type	Method and Description
Suggestion	clone()
boolean	equals(Object obj)
String	getId() The UUID (universally unique identifier) of a single query suggestion.
List<SourceDocument>	getSourceDocuments() 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.
SuggestionValue	getValue() The value for the UUID (universally unique identifier) of a single query suggestion.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setId(String id) The UUID (universally unique identifier) of a single query suggestion.
void	setSourceDocuments(Collection<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.
void	setValue(SuggestionValue value) The value for the UUID (universally unique identifier) of a single query suggestion.
String	toString() Returns a string representation of this object.
Suggestion	withId(String id) The UUID (universally unique identifier) of a single query suggestion.
Suggestion	withSourceDocuments(Collection<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	withSourceDocuments(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	withValue(SuggestionValue value) The value for the UUID (universally unique identifier) of a single query suggestion.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Suggestion

public Suggestion()

Method Detail

setId

public void setId(String id)

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

Parameters:

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

getId

public String getId()

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

Returns:

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

withId

public Suggestion withId(String id)

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

Parameters:

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

Returns:

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

setValue

public void setValue(SuggestionValue value)

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

The value is the text string of a suggestion.

Parameters:

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

The value is the text string of a suggestion.

getValue

public SuggestionValue getValue()

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.

withValue

public Suggestion withValue(SuggestionValue value)

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

The value is the text string of a suggestion.

Parameters:

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

The value is the text string of a suggestion.

Returns:

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

getSourceDocuments

public List<SourceDocument> getSourceDocuments()

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.

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.

setSourceDocuments

public void setSourceDocuments(Collection<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.

Parameters:

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.

withSourceDocuments

public Suggestion withSourceDocuments(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.

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

Parameters:

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.

Returns:

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

withSourceDocuments

public Suggestion withSourceDocuments(Collection<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.

Parameters:

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.

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 Suggestion 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.