com.amazonaws.services.bedrockagentruntime.model

Class RetrieveRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagentruntime.model.RetrieveRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RetrieveRequest()

Method Summary

Modifier and Type	Method and Description
RetrieveRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getKnowledgeBaseId() The unique identifier of the knowledge base to query.
String	getNextToken() If there are more results than can fit in the response, the response returns a nextToken.
KnowledgeBaseRetrievalConfiguration	getRetrievalConfiguration() Contains configurations for the knowledge base query and retrieval process.
KnowledgeBaseQuery	getRetrievalQuery() Contains the query to send the knowledge base.
int	hashCode()
void	setKnowledgeBaseId(String knowledgeBaseId) The unique identifier of the knowledge base to query.
void	setNextToken(String nextToken) If there are more results than can fit in the response, the response returns a nextToken.
void	setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for the knowledge base query and retrieval process.
void	setRetrievalQuery(KnowledgeBaseQuery retrievalQuery) Contains the query to send the knowledge base.
String	toString() Returns a string representation of this object.
RetrieveRequest	withKnowledgeBaseId(String knowledgeBaseId) The unique identifier of the knowledge base to query.
RetrieveRequest	withNextToken(String nextToken) If there are more results than can fit in the response, the response returns a nextToken.
RetrieveRequest	withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration) Contains configurations for the knowledge base query and retrieval process.
RetrieveRequest	withRetrievalQuery(KnowledgeBaseQuery retrievalQuery) Contains the query to send the knowledge base.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RetrieveRequest

public RetrieveRequest()

Method Detail

setKnowledgeBaseId

public void setKnowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to query.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to query.

getKnowledgeBaseId

public String getKnowledgeBaseId()

The unique identifier of the knowledge base to query.

Returns:

The unique identifier of the knowledge base to query.

withKnowledgeBaseId

public RetrieveRequest withKnowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to query.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to query.

Returns:

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

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

setRetrievalConfiguration

public void setRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Parameters:

retrievalConfiguration - Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

getRetrievalConfiguration

public KnowledgeBaseRetrievalConfiguration getRetrievalConfiguration()

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

withRetrievalConfiguration

public RetrieveRequest withRetrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Parameters:

retrievalConfiguration - Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:

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

setRetrievalQuery

public void setRetrievalQuery(KnowledgeBaseQuery retrievalQuery)

Contains the query to send the knowledge base.

Parameters:

retrievalQuery - Contains the query to send the knowledge base.

getRetrievalQuery

public KnowledgeBaseQuery getRetrievalQuery()

Contains the query to send the knowledge base.

Returns:

Contains the query to send the knowledge base.

withRetrievalQuery

public RetrieveRequest withRetrievalQuery(KnowledgeBaseQuery retrievalQuery)

Contains the query to send the knowledge base.

Parameters:

retrievalQuery - Contains the query to send 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 RetrieveRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()