66 строки
4.8 KiB
YAML
66 строки
4.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.UniqueKey"
|
|
fullName: "com.azure.cosmos.models.UniqueKey"
|
|
name: "UniqueKey"
|
|
nameWithType: "UniqueKey"
|
|
summary: "Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos DB service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **UniqueKey**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.UniqueKey.UniqueKey(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.UniqueKey.UniqueKey(List<String> paths)"
|
|
name: "UniqueKey(List<String> paths)"
|
|
nameWithType: "UniqueKey.UniqueKey(List<String> paths)"
|
|
summary: "Instantiates a new Unique key with paths."
|
|
parameters:
|
|
- description: "the unique paths."
|
|
name: "paths"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public UniqueKey(List<String> paths)"
|
|
desc: "Instantiates a new Unique key with paths."
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.UniqueKey.getPaths()"
|
|
fullName: "com.azure.cosmos.models.UniqueKey.getPaths()"
|
|
name: "getPaths()"
|
|
nameWithType: "UniqueKey.getPaths()"
|
|
summary: "Gets the paths, a set of which must be unique for each item in the Azure Cosmos DB service."
|
|
syntax: "public List<String> getPaths()"
|
|
desc: "Gets the paths, a set of which must be unique for each item in the Azure Cosmos DB service.\n\nThe paths to enforce uniqueness on. Each path is a rooted path of the unique property in the item, such as \"/name/first\"."
|
|
returns:
|
|
description: "the unique paths."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.cosmos.models.UniqueKey.setPaths(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.cosmos.models.UniqueKey.setPaths(List<String> paths)"
|
|
name: "setPaths(List<String> paths)"
|
|
nameWithType: "UniqueKey.setPaths(List<String> paths)"
|
|
summary: "Sets the paths, a set of which must be unique for each item in the Azure Cosmos DB service."
|
|
parameters:
|
|
- description: "the unique paths."
|
|
name: "paths"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public UniqueKey setPaths(List<String> paths)"
|
|
desc: "Sets the paths, a set of which must be unique for each item in the Azure Cosmos DB service.\n\nThe paths to enforce uniqueness on. Each path is a rooted path of the unique property in the item, such as \"/name/first\"."
|
|
returns:
|
|
description: "the Unique Key."
|
|
type: "<xref href=\"com.azure.cosmos.models.UniqueKey?alt=com.azure.cosmos.models.UniqueKey&text=UniqueKey\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents a unique key on that enforces uniqueness constraint on items in the container in the Azure Cosmos DB service.\n\n1) For containers, the value of partition key is implicitly a part of each unique key.\n\n2) Uniqueness constraint is also enforced for missing values.\n\nFor instance, if unique key policy defines a unique key with single property path, there could be only one item that has missing value for this property."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.4
|