com.azure.cosmos

Class UniqueKeyPolicy

java.lang.Object

com.azure.cosmos.JsonSerializable

com.azure.cosmos.UniqueKeyPolicy

public class UniqueKeyPolicy
extends JsonSerializable

Represents the unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.

Constructor Summary

Constructors

Constructor and Description
UniqueKeyPolicy()

Method Summary

Modifier and Type	Method and Description
Collection<UniqueKey>	uniqueKeys() Gets or sets collection of UniqueKey that guarantee uniqueness of documents in collection in the Azure Cosmos DB service.
UniqueKeyPolicy	uniqueKeys(List<UniqueKey> uniqueKeys) Unique keys unique key policy.

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

UniqueKeyPolicy

public UniqueKeyPolicy()

Method Detail

uniqueKeys

public Collection<UniqueKey> uniqueKeys()

Gets or sets collection of UniqueKey that guarantee uniqueness of documents in collection in the Azure Cosmos DB service.

Returns:

the unique keys.

uniqueKeys

public UniqueKeyPolicy uniqueKeys(List<UniqueKey> uniqueKeys)

Unique keys unique key policy.

Parameters:

uniqueKeys - the unique keys

Returns:

the unique key policy

Throws:

IllegalArgumentException - thrown if an error occurs