Interface Index.Builder

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

  • Method Details

    • vectorBucketName

      Index.Builder vectorBucketName(String vectorBucketName)

      The name of the vector bucket that contains the vector index.

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

    • indexName

      Index.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.

    • indexArn

      Index.Builder indexArn(String indexArn)

      The Amazon Resource Name (ARN) of the vector index.

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

    • creationTime

      Index.Builder creationTime(Instant creationTime)

      Date and time when the vector index was created.

      Parameters:
      creationTime - Date and time when the vector index was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataType

      Index.Builder dataType(String dataType)

      The data type of the vectors inserted into the vector index.

      Parameters:
      dataType - The data type of the vectors inserted into the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataType

      Index.Builder dataType(DataType dataType)

      The data type of the vectors inserted into the vector index.

      Parameters:
      dataType - The data type of the vectors inserted into the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dimension

      Index.Builder dimension(Integer dimension)

      The number of values in the vectors that are inserted into the vector index.

      Parameters:
      dimension - The number of values in the vectors that are inserted into the vector index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distanceMetric

      Index.Builder distanceMetric(String distanceMetric)

      The distance metric to be used for similarity search.

      Parameters:
      distanceMetric - The distance metric to be used for similarity search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • distanceMetric

      Index.Builder distanceMetric(DistanceMetric distanceMetric)

      The distance metric to be used for similarity search.

      Parameters:
      distanceMetric - The distance metric to be used for similarity search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadataConfiguration

      Index.Builder metadataConfiguration(MetadataConfiguration metadataConfiguration)

      The metadata configuration for the vector index.

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

    • metadataConfiguration

      default Index.Builder metadataConfiguration(Consumer<MetadataConfiguration.Builder> metadataConfiguration)

      The metadata configuration for the vector index.

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

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

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