Share via

UniqueKey Class

  • Reference
Package:
com.microsoft.azure.documentdb
Maven Artifact:
com.microsoft.azure:azure-documentdb:2.4.7

public class UniqueKey
extends JsonSerializable

Represents a unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. 1) For partitioned collections, the value of partition key is implicitly a part of each unique key. 2) Uniqueness constraint is also enforced for missing values. For instance, if unique key policy defines a unique key with single property path, there could be only one document that has missing value for this property.

Constructor Summary

Constructor Description
UniqueKey()
UniqueKey(String jsonString)
UniqueKey(JSONObject jsonObject)

Method Summary

Modifier and Type Method and Description
java.util.Collection<java.lang.String> getPaths()

Gets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.
void setPaths(Collection<String> paths)

Sets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.

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

UniqueKey

public UniqueKey()

UniqueKey

public UniqueKey(String jsonString)

Parameters:

jsonString

UniqueKey

public UniqueKey(JSONObject jsonObject)

Parameters:

jsonObject

Method Details

getPaths

public Collection getPaths()

Gets the paths, a set of which must be unique for each document in the Azure Cosmos DB service. The paths to enforce uniqueness on. Each path is a rooted path of the unique property in the document, such as "/name/first".

Returns:

the unique paths.

setPaths

public void setPaths(Collection paths)

Sets the paths, a set of which must be unique for each document in the Azure Cosmos DB service. The paths to enforce uniqueness on. Each path is a rooted path of the unique property in the document, such as "/name/first".

Parameters:

paths - the unique paths.

Applies to