Index Class

Package:

com.microsoft.azure.documentdb

Maven Artifact:

com.microsoft.azure:azure-documentdb:2.4.7

• java.lang.Object
• • com.microsoft.azure.documentdb.JsonSerializable
  • • com.microsoft.azure.documentdb.Index

public abstract class Index
extends JsonSerializable

Represents the index of a collection in the Azure Cosmos DB database service.

Constructor Summary

Modifier	Constructor	Description
protected	Index(IndexKind indexKind)	Constructor.
protected	Index(String jsonString, IndexKind indexKind)	Constructor.
protected	Index(JSONObject jsonObject, IndexKind indexKind)	Constructor.

Method Summary

Modifier and Type	Method and Description
static HashIndex	Hash(DataType dataType) Returns an instance of HashIndex class with specified DataType.
static HashIndex	Hash(DataType dataType, int precision) Returns an instance of HashIndex class with specified DataType and precision.
static RangeIndex	Range(DataType dataType) Returns an instance of RangeIndex class with specified DataType.
static RangeIndex	Range(DataType dataType, int precision) Returns an instance of RangeIndex class with specified DataType and precision.
static SpatialIndex	Spatial(DataType dataType) Returns an instance of SpatialIndex class with specified DataType.
IndexKind	getKind() Gets index kind.

Methods inherited from JsonSerializable

<T>getCollection <T>getObject <T>set <T>toObject get getBoolean getCollection getDouble getHashMap getInt getLogger getLong getMapper getObject getObjectByPath getString has remove toJson toJson toString toString

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Index

protected Index(IndexKind indexKind)

Constructor.

Parameters:

indexKind - the kind of the index

Index

protected Index(String jsonString, IndexKind indexKind)

Constructor.

Parameters:

jsonString - the json string that represents the index.

indexKind - the kind of the index

Index

protected Index(JSONObject jsonObject, IndexKind indexKind)

Constructor.

Parameters:

jsonObject - the json object that represents the index.

indexKind - the kind of the index

Method Details

Hash

public static HashIndex Hash(DataType dataType)

Returns an instance of HashIndex class with specified DataType.

Here is an example to create HashIndex instance passing in the DataType:

HashIndex hashIndex = Index.Hash(DataType.String);

Parameters:

dataType - specifies the target data type for the index path specification.

Returns:

an instance of HashIndex type.

Hash

public static HashIndex Hash(DataType dataType, int precision)

Returns an instance of HashIndex class with specified DataType and precision.

Here is an example to create HashIndex instance passing in the DataType and precision:

HashIndex hashIndex = Index.Hash(DataType.String, 3);

Parameters:

dataType - specifies the target data type for the index path specification.

precision - specifies the precision to be used for the data type associated with this index.

Returns:

an instance of HashIndex type.

Range

public static RangeIndex Range(DataType dataType)

Returns an instance of RangeIndex class with specified DataType.

Here is an example to create RangeIndex instance passing in the DataType:

RangeIndex rangeIndex = Index.Range(DataType.Number);

Parameters:

dataType - the data type.

Returns:

an instance of RangeIndex type.

Range

public static RangeIndex Range(DataType dataType, int precision)

Returns an instance of RangeIndex class with specified DataType and precision.

Here is an example to create RangeIndex instance passing in the DataType and precision:

RangeIndex rangeIndex = Index.Range(DataType.Number, -1);

Parameters:

dataType - specifies the target data type for the index path specification.

precision - specifies the precision to be used for the data type associated with this index.

Returns:

an instance of RangeIndex type.

Spatial

public static SpatialIndex Spatial(DataType dataType)

Returns an instance of SpatialIndex class with specified DataType.

Here is an example to create SpatialIndex instance passing in the DataType:

SpatialIndex spatialIndex = Index.Spatial(DataType.Point);

Parameters:

dataType - specifies the target data type for the index path specification.

Returns:

an instance of SpatialIndex type.

getKind

public IndexKind getKind()

Gets index kind.

Returns:

the index kind.