Class S3VectorsConfiguration

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.S3VectorsConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3VectorsConfiguration.Builder,S3VectorsConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class S3VectorsConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3VectorsConfiguration.Builder,S3VectorsConfiguration>

Contains the storage configuration of the knowledge base for S3 vectors.

See Also:

  • Method Details

    • indexArn

      public final String indexArn()

      The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.

      Returns:
      The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.

    • indexName

      public final String indexName()

      The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.

      Returns:
      The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.

    • vectorBucketArn

      public final String vectorBucketArn()

      The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.

      Returns:
      The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.

    • toBuilder

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

    • builder

      public static S3VectorsConfiguration.Builder builder()

    • serializableBuilderClass

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