Class UpdateKnowledgeBaseRequest

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.UpdateKnowledgeBaseRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateKnowledgeBaseRequest.Builder,UpdateKnowledgeBaseRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateKnowledgeBaseRequest extends BedrockAgentRequest implements ToCopyableBuilder<UpdateKnowledgeBaseRequest.Builder,UpdateKnowledgeBaseRequest>

  • Method Details

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The unique identifier of the knowledge base to update.

      Returns:
      The unique identifier of the knowledge base to update.

    • name

      public final String name()

      Specifies a new name for the knowledge base.

      Returns:
      Specifies a new name for the knowledge base.

    • description

      public final String description()

      Specifies a new description for the knowledge base.

      Returns:
      Specifies a new description for the knowledge base.

    • roleArn

      public final String roleArn()

      Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

      Returns:
      Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

    • knowledgeBaseConfiguration

      public final KnowledgeBaseConfiguration knowledgeBaseConfiguration()

      Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

      Returns:
      Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

    • storageConfiguration

      public final StorageConfiguration storageConfiguration()

      Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

      Returns:
      Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

    • toBuilder

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

    • builder

      public static UpdateKnowledgeBaseRequest.Builder builder()

    • serializableBuilderClass

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