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

Class AgentKnowledgeBase

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.AgentKnowledgeBase

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AgentKnowledgeBase.Builder,AgentKnowledgeBase>

@Generated("software.amazon.awssdk:codegen")
public final class AgentKnowledgeBase
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgentKnowledgeBase.Builder,AgentKnowledgeBase>

Contains details about a knowledge base that is associated with an agent.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AgentKnowledgeBase.Builder

Method Summary

Modifier and Type	Method	Description
String	agentId()	The unique identifier of the agent with which the knowledge base is associated.
String	agentVersion()	The version of the agent with which the knowledge base is associated.
static AgentKnowledgeBase.Builder	builder()
Instant	createdAt()	The time at which the association between the agent and the knowledge base was created.
String	description()	The description of the association between the agent and the knowledge base.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the association between the agent and the knowledge base.
KnowledgeBaseState	knowledgeBaseState()	Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
String	knowledgeBaseStateAsString()	Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
List<SdkField<?>>	sdkFields()
static Class<? extends AgentKnowledgeBase.Builder>	serializableBuilderClass()
AgentKnowledgeBase.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Instant	updatedAt()	The time at which the association between the agent and the knowledge base was last updated.

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

agentId

public final String agentId()

The unique identifier of the agent with which the knowledge base is associated.

Returns:

The unique identifier of the agent with which the knowledge base is associated.

agentVersion

public final String agentVersion()

The version of the agent with which the knowledge base is associated.

Returns:

The version of the agent with which the knowledge base is associated.

createdAt

public final Instant createdAt()

The time at which the association between the agent and the knowledge base was created.

Returns:

The time at which the association between the agent and the knowledge base was created.

description

public final String description()

The description of the association between the agent and the knowledge base.

Returns:

The description of the association between the agent and the knowledge base.

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the association between the agent and the knowledge base.

Returns:

The unique identifier of the association between the agent and the knowledge base.

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

updatedAt

public final Instant updatedAt()

The time at which the association between the agent and the knowledge base was last updated.

Returns:

The time at which the association between the agent and the knowledge base was last updated.

toBuilder

public AgentKnowledgeBase.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AgentKnowledgeBase.Builder,AgentKnowledgeBase>

builder

public static AgentKnowledgeBase.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo