Interface VectorIndexDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<VectorIndexDescription.Builder,VectorIndexDescription>, SdkBuilder<VectorIndexDescription.Builder,VectorIndexDescription>, SdkPojo
Enclosing class:
VectorIndexDescription
@Mutable @NotThreadSafe public static interface VectorIndexDescription.Builder extends SdkPojo, CopyableBuilder<VectorIndexDescription.Builder,VectorIndexDescription>

  • Method Details

    • indexName

      VectorIndexDescription.Builder indexName(String indexName)

      The name of the vector index.

      Parameters:
      indexName - The name of the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchSchema

      VectorIndexDescription.Builder searchSchema(Collection<SearchSchemaElement> searchSchema)

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

      Parameters:
      searchSchema - The search schema that defines partition key and inline filter attributes for the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchSchema

      VectorIndexDescription.Builder searchSchema(SearchSchemaElement... searchSchema)

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

      Parameters:
      searchSchema - The search schema that defines partition key and inline filter attributes for the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchSchema

      VectorIndexDescription.Builder searchSchema(Consumer<SearchSchemaElement.Builder>... searchSchema)

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

      This is a convenience method that creates an instance of the SearchSchemaElement.Builder avoiding the need to create one manually via SearchSchemaElement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchSchema(List<SearchSchemaElement>).

      Parameters:
      searchSchema - a consumer that will call methods on SearchSchemaElement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • projection

      VectorIndexDescription.Builder projection(Projection projection)

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

      Parameters:
      projection - Specifies attributes that are copied (projected) from the table into the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projection

      default VectorIndexDescription.Builder projection(Consumer<Projection.Builder> projection)

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

      This is a convenience method that creates an instance of the Projection.Builder avoiding the need to create one manually via Projection.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to projection(Projection).

      Parameters:
      projection - a consumer that will call methods on Projection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vectorAttribute

      VectorIndexDescription.Builder vectorAttribute(VectorAttributeDefinition vectorAttribute)

      The vector attribute configuration for the index.

      Parameters:
      vectorAttribute - The vector attribute configuration for the index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectorAttribute

      default VectorIndexDescription.Builder vectorAttribute(Consumer<VectorAttributeDefinition.Builder> vectorAttribute)

      The vector attribute configuration for the index.

      This is a convenience method that creates an instance of the VectorAttributeDefinition.Builder avoiding the need to create one manually via VectorAttributeDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectorAttribute(VectorAttributeDefinition).

      Parameters:
      vectorAttribute - a consumer that will call methods on VectorAttributeDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dimensions

      VectorIndexDescription.Builder dimensions(Long dimensions)

      The number of dimensions in each vector.

      Parameters:
      dimensions - The number of dimensions in each vector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distanceFunction

      VectorIndexDescription.Builder distanceFunction(String distanceFunction)

      The distance function used to calculate similarity between vectors.

      Parameters:
      distanceFunction - The distance function used to calculate similarity between vectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distanceFunction

      VectorIndexDescription.Builder distanceFunction(VectorDistanceFunction distanceFunction)

      The distance function used to calculate similarity between vectors.

      Parameters:
      distanceFunction - The distance function used to calculate similarity between vectors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • indexStatus

      VectorIndexDescription.Builder indexStatus(String indexStatus)

      The current state of the vector index:

      • CREATING - The index is being created.

      • ACTIVE - The index is ready for use.

      • DELETING - The index is being deleted.

      Parameters:
      indexStatus - The current state of the vector index:

      • CREATING - The index is being created.

      • ACTIVE - The index is ready for use.

      • DELETING - The index is being deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • indexStatus

      VectorIndexDescription.Builder indexStatus(IndexStatus indexStatus)

      The current state of the vector index:

      • CREATING - The index is being created.

      • ACTIVE - The index is ready for use.

      • DELETING - The index is being deleted.

      Parameters:
      indexStatus - The current state of the vector index:

      • CREATING - The index is being created.

      • ACTIVE - The index is ready for use.

      • DELETING - The index is being deleted.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • backfilling

      VectorIndexDescription.Builder backfilling(Boolean backfilling)

      Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.

      Parameters:
      backfilling - Specifies whether the index is currently backfilling. During backfill, SearchVectors operations might return incomplete results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexSizeBytes

      VectorIndexDescription.Builder indexSizeBytes(Long indexSizeBytes)

      The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Parameters:
      indexSizeBytes - The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • itemCount

      VectorIndexDescription.Builder itemCount(Long itemCount)

      The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

      Parameters:
      itemCount - The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexArn

      VectorIndexDescription.Builder indexArn(String indexArn)

      The Amazon Resource Name (ARN) that uniquely identifies the vector index.

      Parameters:
      indexArn - The Amazon Resource Name (ARN) that uniquely identifies the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.