Package com.azure.cosmos.models

Enum CosmosVectorIndexType

java.lang.Object

java.lang.Enum<CosmosVectorIndexType>

com.azure.cosmos.models.CosmosVectorIndexType

All Implemented Interfaces:

Serializable, Comparable<CosmosVectorIndexType>, java.lang.constant.Constable

public enum CosmosVectorIndexType
extends Enum<CosmosVectorIndexType>

Defines the index type of vector index specification in the Azure Cosmos DB service.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISK_ANN	Represents a disk ANN vector index type.
FLAT	Represents a flat vector index type.
QUANTIZED_FLAT	Represents a quantized flat vector index type.

Method Summary

Modifier and Type	Method	Description
String	toString()
static CosmosVectorIndexType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CosmosVectorIndexType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FLAT

public static final CosmosVectorIndexType FLAT

Represents a flat vector index type.

QUANTIZED_FLAT

public static final CosmosVectorIndexType QUANTIZED_FLAT

Represents a quantized flat vector index type.

DISK_ANN

public static final CosmosVectorIndexType DISK_ANN

Represents a disk ANN vector index type.

Method Details

values

public static CosmosVectorIndexType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CosmosVectorIndexType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<CosmosVectorIndexType>