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>

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

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

    • toBuilder

      public AssociateAgentKnowledgeBaseRequest.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<AssociateAgentKnowledgeBaseRequest.Builder,AssociateAgentKnowledgeBaseRequest>
      Specified by:
      toBuilder in class BedrockAgentRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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