com.azure.data.cosmos

Class UniqueKey

java.lang.Object

com.azure.data.cosmos.JsonSerializable

com.azure.data.cosmos.UniqueKey

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.

See Also:

UniqueKeyPolicy

Constructor Summary

Constructors

Constructor and Description
UniqueKey()

Method Summary

Modifier and Type	Method and Description
Collection<String>	paths() Gets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.
UniqueKey	paths(List<String> paths) Sets the paths, a set of which must be unique for each document in the Azure Cosmos DB service.

Methods inherited from class com.azure.data.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

UniqueKey

public UniqueKey()

Method Detail

paths

public Collection<String> paths()

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.

paths

public UniqueKey paths(List<String> 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.

Returns:

the Unique Key.