com.amazonaws.services.bedrockagentruntime.model

Class RetrieveResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.bedrockagentruntime.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	getNextToken() If there are more results than can fit in the response, the response returns a nextToken.
List<KnowledgeBaseRetrievalResult>	getRetrievalResults() A list of results from querying the knowledge base.
int	hashCode()
void	setNextToken(String nextToken) If there are more results than can fit in the response, the response returns a nextToken.
void	setRetrievalResults(Collection<KnowledgeBaseRetrievalResult> retrievalResults) A list of results from querying the knowledge base.
String	toString() Returns a string representation of this object.
RetrieveResult	withNextToken(String nextToken) If there are more results than can fit in the response, the response returns a nextToken.
RetrieveResult	withRetrievalResults(Collection<KnowledgeBaseRetrievalResult> retrievalResults) A list of results from querying the knowledge base.
RetrieveResult	withRetrievalResults(KnowledgeBaseRetrievalResult... retrievalResults) A list of results from querying the knowledge base.

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

setNextToken

public void setNextToken(String nextToken)

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Parameters:

nextToken - If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

getNextToken

public String getNextToken()

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Returns:

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

withNextToken

public RetrieveResult withNextToken(String nextToken)

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Parameters:

nextToken - If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Returns:

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

getRetrievalResults

public List<KnowledgeBaseRetrievalResult> getRetrievalResults()

A list of results from querying the knowledge base.

Returns:

A list of results from querying the knowledge base.

setRetrievalResults

public void setRetrievalResults(Collection<KnowledgeBaseRetrievalResult> retrievalResults)

A list of results from querying the knowledge base.

Parameters:

retrievalResults - A list of results from querying the knowledge base.

withRetrievalResults

public RetrieveResult withRetrievalResults(KnowledgeBaseRetrievalResult... retrievalResults)

A list of results from querying the knowledge base.

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

Parameters:

retrievalResults - A list of results from querying the knowledge base.

Returns:

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

withRetrievalResults

public RetrieveResult withRetrievalResults(Collection<KnowledgeBaseRetrievalResult> retrievalResults)

A list of results from querying the knowledge base.

Parameters:

retrievalResults - A list of results from querying the knowledge base.

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