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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AgentKnowledgeBase.Builder,AgentKnowledgeBase>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.