Package software.amazon.awssdk.services.bedrockagent.model

Class AssociateAgentKnowledgeBaseRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.AssociateAgentKnowledgeBaseRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateAgentKnowledgeBaseRequest.Builder,AssociateAgentKnowledgeBaseRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociateAgentKnowledgeBaseRequest.Builder

Method Summary

Modifier and Type	Method	Description
final String	agentId()	The unique identifier of the agent with which you want to associate the knowledge base.
final String	agentVersion()	The version of the agent with which you want to associate the knowledge base.
static AssociateAgentKnowledgeBaseRequest.Builder	builder()
final String	description()	A description of what the agent should use the knowledge base for.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	knowledgeBaseId()	The unique identifier of the knowledge base to associate with the agent.
final KnowledgeBaseState	knowledgeBaseState()	Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
final String	knowledgeBaseStateAsString()	Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AssociateAgentKnowledgeBaseRequest.Builder>	serializableBuilderClass()
AssociateAgentKnowledgeBaseRequest.Builder	toBuilder()
final 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 Details

agentId

public final String agentId()

The unique identifier of the agent with which you want to associate the knowledge base.

Returns:

The unique identifier of the agent with which you want to associate the knowledge base.

agentVersion

public final String agentVersion()

The version of the agent with which you want to associate the knowledge base.

Returns:

The version of the agent with which you want to associate the knowledge base.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge base to associate with the agent.

Returns:

The unique identifier of the knowledge base to associate with the agent.

description

public final String description()

A description of what the agent should use the knowledge base for.

Returns:

A description of what the agent should use the knowledge base for.

knowledgeBaseState

public final KnowledgeBaseState knowledgeBaseState()

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

If the service returns an enum value that is not available in the current SDK version, knowledgeBaseState will return KnowledgeBaseState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseStateAsString().

Returns:

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

See Also:

• KnowledgeBaseState

knowledgeBaseStateAsString

public final String knowledgeBaseStateAsString()

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

If the service returns an enum value that is not available in the current SDK version, knowledgeBaseState will return KnowledgeBaseState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseStateAsString().

Returns:

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

See Also:

• KnowledgeBaseState

toBuilder

public AssociateAgentKnowledgeBaseRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateAgentKnowledgeBaseRequest.Builder,AssociateAgentKnowledgeBaseRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static AssociateAgentKnowledgeBaseRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociateAgentKnowledgeBaseRequest.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