Class StorageConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.StorageConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<StorageConfiguration.Builder,StorageConfiguration>

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

Contains the storage configuration of the knowledge base.

See Also:
  • Method Details

    • mongoDbAtlasConfiguration

      public final MongoDbAtlasConfiguration mongoDbAtlasConfiguration()

      Contains the storage configuration of the knowledge base in MongoDB Atlas.

      Returns:
      Contains the storage configuration of the knowledge base in MongoDB Atlas.
    • neptuneAnalyticsConfiguration

      public final NeptuneAnalyticsConfiguration neptuneAnalyticsConfiguration()

      Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see Create a vector index in Amazon Neptune Analytics..

      Returns:
      Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see Create a vector index in Amazon Neptune Analytics..
    • opensearchManagedClusterConfiguration

      public final OpenSearchManagedClusterConfiguration opensearchManagedClusterConfiguration()

      Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see Create a vector index in Amazon OpenSearch Service.

      Returns:
      Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see Create a vector index in Amazon OpenSearch Service.
    • opensearchServerlessConfiguration

      public final OpenSearchServerlessConfiguration opensearchServerlessConfiguration()

      Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

      Returns:
      Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
    • pineconeConfiguration

      public final PineconeConfiguration pineconeConfiguration()

      Contains the storage configuration of the knowledge base in Pinecone.

      Returns:
      Contains the storage configuration of the knowledge base in Pinecone.
    • rdsConfiguration

      public final RdsConfiguration rdsConfiguration()

      Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

      Returns:
      Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
    • redisEnterpriseCloudConfiguration

      public final RedisEnterpriseCloudConfiguration redisEnterpriseCloudConfiguration()

      Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

      Returns:
      Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
    • s3VectorsConfiguration

      public final S3VectorsConfiguration s3VectorsConfiguration()

      The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage.

      Returns:
      The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage.
    • type

      public final KnowledgeBaseStorageType type()

      The vector store service in which the knowledge base is stored.

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

      Returns:
      The vector store service in which the knowledge base is stored.
      See Also:
    • typeAsString

      public final String typeAsString()

      The vector store service in which the knowledge base is stored.

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

      Returns:
      The vector store service in which the knowledge base is stored.
      See Also:
    • toBuilder

      public StorageConfiguration.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<StorageConfiguration.Builder,StorageConfiguration>
      Returns:
      a builder for type T
    • builder

      public static StorageConfiguration.Builder builder()
    • serializableBuilderClass

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