Class VectorIndexMetadata

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.VectorIndexMetadata

@SdkPublicApi
@ThreadSafe
public final class VectorIndexMetadata
extends Object

Read-only metadata describing a vector index on a mapped table. Used when resolving table.vectorIndex(indexName) handles and for programmatic table schema definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VectorIndexMetadata.Builder	A builder for VectorIndexMetadata.

Method Summary

Modifier and Type	Method	Description
static VectorIndexMetadata.Builder	builder()
int	dimensions()	The number of dimensions in the vector embedding.
DistanceFunction	distanceFunction()	The distance function used for similarity search on this index.
boolean	equals(Object o)
static VectorIndexMetadata	fromEnhancedVectorIndex(EnhancedVectorIndex enhancedVectorIndex)	Creates a VectorIndexMetadata from an EnhancedVectorIndex.
int	hashCode()
String	indexName()	The name of the vector index.
Projection	projection()	The attribute projection setting for this vector index.
List<SearchSchemaElement>	searchSchemaElements()	The search schema elements for this vector index.
VectorIndexMetadata.Builder	toBuilder()
String	vectorAttributeName()	The name of the table attribute that stores the vector embedding for this index.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static VectorIndexMetadata.Builder builder()

fromEnhancedVectorIndex

public static VectorIndexMetadata fromEnhancedVectorIndex(EnhancedVectorIndex enhancedVectorIndex)

Creates a VectorIndexMetadata from an EnhancedVectorIndex.

toBuilder

public VectorIndexMetadata.Builder toBuilder()

indexName

public String indexName()

The name of the vector index.

vectorAttributeName

public String vectorAttributeName()

The name of the table attribute that stores the vector embedding for this index.

dimensions

public int dimensions()

The number of dimensions in the vector embedding.

distanceFunction

public DistanceFunction distanceFunction()

The distance function used for similarity search on this index.

projection

public Projection projection()

The attribute projection setting for this vector index.

searchSchemaElements

public List<SearchSchemaElement> searchSchemaElements()

The search schema elements for this vector index.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object