com.azure.cosmos

Class HashIndex

java.lang.Object

com.azure.cosmos.JsonSerializable

com.azure.cosmos.Index

com.azure.cosmos.HashIndex

public final class HashIndex
extends Index

Represents a hash index in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Constructor and Description
HashIndex(DataType dataType) Specifies an instance of HashIndex class with specified DataType.
HashIndex(DataType dataType, int precision) Initializes a new instance of the HashIndex class with specified DataType and precision.

Method Summary

Modifier and Type	Method and Description
DataType	getDataType() Gets data type.
int	getPrecision() Gets precision.
HashIndex	setDataType(DataType dataType) Sets data type.
HashIndex	setPrecision(int precision) Sets precision.

Methods inherited from class com.azure.cosmos.Index

getKind, hash, hash, range, range, spatial

Methods inherited from class com.azure.cosmos.JsonSerializable

get, getBoolean, getCollection, getDouble, getInt, getList, getLogger, getLong, getMap, getObject, getObjectByPath, getString, has, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HashIndex

public HashIndex(DataType dataType)

Specifies an instance of HashIndex class with specified DataType.

Here is an example to instantiate HashIndex class passing in the DataType:

HashIndex hashIndex = new HashIndex(DataType.STRING);

Parameters:

dataType - the data type.

HashIndex

public HashIndex(DataType dataType,
                 int precision)

Initializes a new instance of the HashIndex class with specified DataType and precision.

Here is an example to instantiate HashIndex class passing in the DataType: HashIndex hashIndex = new HashIndex(DataType.STRING, 3);

Parameters:

dataType - the data type.

precision - the precision.

Method Detail

getDataType

public DataType getDataType()

Gets data type.

Returns:

the data type.

setDataType

public HashIndex setDataType(DataType dataType)

Sets data type.

Parameters:

dataType - the data type.

Returns:

the Hash Index.

getPrecision

public int getPrecision()

Gets precision.

Returns:

the precision.

setPrecision

public HashIndex setPrecision(int precision)

Sets precision.

Parameters:

precision - the precision.

Returns:

the Hash Index.