Class VectorIndex

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

Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection.

See Also:

  • Method Details

    • indexName

      public final String indexName()

      The name of the vector index.

      Returns:
      The name of the vector index.

    • vectorAttribute

      public final VectorAttributeDefinition vectorAttribute()

      The vector attribute configuration for the index.

      Returns:
      The vector attribute configuration for the index.

    • hasSearchSchema

      public final boolean hasSearchSchema()
      For responses, this returns true if the service returned a value for the SearchSchema property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • searchSchema

      public final List<SearchSchemaElement> searchSchema()

      The search schema that defines partition key and inline filter attributes for the vector index.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSearchSchema() method.

      Returns:
      The search schema that defines partition key and inline filter attributes for the vector index.

    • projection

      public final Projection projection()

      Specifies attributes that are copied (projected) from the table into the vector index.

      Returns:
      Specifies attributes that are copied (projected) from the table into the vector index.

    • dimensions

      public final Long dimensions()

      The number of dimensions in each vector.

      Returns:
      The number of dimensions in each vector.

    • distanceFunction

      public final VectorDistanceFunction distanceFunction()

      The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

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

      Returns:
      The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.
      See Also:

    • distanceFunctionAsString

      public final String distanceFunctionAsString()

      The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

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

      Returns:
      The distance function used to calculate similarity between vectors. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.
      See Also:

    • toBuilder

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

    • builder

      public static VectorIndex.Builder builder()

    • serializableBuilderClass

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