Package software.amazon.awssdk.services.bedrockagentruntime.model

Class RetrieveRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest

software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RetrieveRequest
extends BedrockAgentRuntimeRequest
implements ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetrieveRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RetrieveRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GuardrailConfiguration	guardrailConfiguration()	Guardrail settings.
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the knowledge base to query.
String	nextToken()	If there are more results than can fit in the response, the response returns a nextToken.
KnowledgeBaseRetrievalConfiguration	retrievalConfiguration()	Contains configurations for the knowledge base query and retrieval process.
KnowledgeBaseQuery	retrievalQuery()	Contains the query to send the knowledge base.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieveRequest.Builder>	serializableBuilderClass()
RetrieveRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

guardrailConfiguration

public final GuardrailConfiguration guardrailConfiguration()

Guardrail settings.

Returns:

Guardrail settings.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge base to query.

Returns:

The unique identifier of the knowledge base to query.

nextToken

public final 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.

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.

retrievalConfiguration

public final KnowledgeBaseRetrievalConfiguration retrievalConfiguration()

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.

retrievalQuery

public final KnowledgeBaseQuery retrievalQuery()

Contains the query to send the knowledge base.

Returns:

Contains the query to send the knowledge base.

toBuilder

public RetrieveRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieveRequest.Builder,RetrieveRequest>

Specified by:

toBuilder in class BedrockAgentRuntimeRequest

builder

public static RetrieveRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RetrieveRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo