Share via

UniqueKey Class

  • Reference
Package:
com.microsoft.azure.cosmosdb

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)

Method Summary

Modifier and Type Method and Description
Collection<String> 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".
void setPaths(Collection<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".

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) JsonSerializable.getHashMap() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) JsonSerializable.getString(String propertyName) JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Constructor Details

UniqueKey

public UniqueKey()

UniqueKey

public UniqueKey(String jsonString)

Parameters:

jsonString

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