Package com.azure.resourcemanager.cosmos.models

Class UniqueKey

java.lang.Object

com.azure.resourcemanager.cosmos.models.UniqueKey

public final class UniqueKey
extends Object

The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.

Constructor Summary

Constructors

Constructor	Description
UniqueKey()	Creates an instance of UniqueKey class.

Method Summary

Modifier and Type	Method	Description
List<String>	paths()	Get the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.
void	validate()	Validates the instance.
UniqueKey	withPaths(List<String> paths)	Set the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UniqueKey

public UniqueKey()

Creates an instance of UniqueKey class.

Method Details

paths

public List<String> paths()

Get the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.

Returns:

the paths value.

withPaths

public UniqueKey withPaths(List<String> paths)

Set the paths property: List of paths must be unique for each document in the Azure Cosmos DB service.

Parameters:

paths - the paths value to set.

Returns:

the UniqueKey object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.