com.microsoft.azure.cosmosdb

Class HashIndex

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Index

com.microsoft.azure.cosmosdb.HashIndex

All Implemented Interfaces:

Serializable

public final class HashIndex
extends Index

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

See Also:

Serialized Form

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.
HashIndex(org.json.JSONObject jsonObject) Initializes a new instance of the HashIndex class with json object.
HashIndex(String jsonString) Initializes a new instance of the HashIndex class with json string.

Method Summary

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

Methods inherited from class com.microsoft.azure.cosmosdb.Index

getKind, Hash, Hash, Range, Range, Spatial

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, 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.

HashIndex

public HashIndex(String jsonString)

Initializes a new instance of the HashIndex class with json string.

Parameters:

jsonString - the json string that represents the index.

HashIndex

public HashIndex(org.json.JSONObject jsonObject)

Initializes a new instance of the HashIndex class with json object.

Parameters:

jsonObject - the json object that represents the index.

Method Detail

getDataType

public DataType getDataType()

Gets data type.

Returns:

the data type.

setDataType

public void setDataType(DataType dataType)

Sets data type.

Parameters:

dataType - the data type.

getPrecision

public int getPrecision()

Gets precision.

Returns:

the precision.

setPrecision

public void setPrecision(int precision)

Sets precision.

Parameters:

precision - the precision.