com.amazonaws.services.kendra.model

Class RetrieveResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kendra.model.RetrieveResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RetrieveResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RetrieveResult()

Method Summary

Modifier and Type	Method and Description
RetrieveResult	clone()
boolean	equals(Object obj)
String	getQueryId() The identifier of query used for the search.
List<RetrieveResultItem>	getResultItems() The results of the retrieved relevant passages for the search.
int	hashCode()
void	setQueryId(String queryId) The identifier of query used for the search.
void	setResultItems(Collection<RetrieveResultItem> resultItems) The results of the retrieved relevant passages for the search.
String	toString() Returns a string representation of this object.
RetrieveResult	withQueryId(String queryId) The identifier of query used for the search.
RetrieveResult	withResultItems(Collection<RetrieveResultItem> resultItems) The results of the retrieved relevant passages for the search.
RetrieveResult	withResultItems(RetrieveResultItem... resultItems) The results of the retrieved relevant passages for the search.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrieveResult

public RetrieveResult()

Method Detail

setQueryId

public void setQueryId(String queryId)

The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

Parameters:

queryId - The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

getQueryId

public String getQueryId()

The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

Returns:

The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

withQueryId

public RetrieveResult withQueryId(String queryId)

The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

Parameters:

queryId - The identifier of query used for the search. You also use QueryId to identify the search when using the Submitfeedback API.

Returns:

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

getResultItems

public List<RetrieveResultItem> getResultItems()

The results of the retrieved relevant passages for the search.

Returns:

The results of the retrieved relevant passages for the search.

setResultItems

public void setResultItems(Collection<RetrieveResultItem> resultItems)

The results of the retrieved relevant passages for the search.

Parameters:

resultItems - The results of the retrieved relevant passages for the search.

withResultItems

public RetrieveResult withResultItems(RetrieveResultItem... resultItems)

The results of the retrieved relevant passages for the search.

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

Parameters:

resultItems - The results of the retrieved relevant passages for the search.

Returns:

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

withResultItems

public RetrieveResult withResultItems(Collection<RetrieveResultItem> resultItems)

The results of the retrieved relevant passages for the search.

Parameters:

resultItems - The results of the retrieved relevant passages for the search.

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 RetrieveResult clone()

Overrides:

clone in class Object