-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.cosmos.models.PartitionKeyDefinition.yml
109 lines (109 loc) · 7.58 KB
/
com.azure.cosmos.models.PartitionKeyDefinition.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
### YamlMime:JavaType
uid: "com.azure.cosmos.models.PartitionKeyDefinition"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition"
name: "PartitionKeyDefinition"
nameWithType: "PartitionKeyDefinition"
summary: "Represents a partition key definition in the Azure Cosmos DB database 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 **PartitionKeyDefinition**"
constructors:
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.PartitionKeyDefinition()"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.PartitionKeyDefinition()"
name: "PartitionKeyDefinition()"
nameWithType: "PartitionKeyDefinition.PartitionKeyDefinition()"
summary: "Constructor."
syntax: "public PartitionKeyDefinition()"
desc: "Constructor. Creates a new instance of the PartitionKeyDefinition object."
methods:
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.getKind()"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.getKind()"
name: "getKind()"
nameWithType: "PartitionKeyDefinition.getKind()"
summary: "Sets the partition algorithm used to calculate the partition id given a partition key."
syntax: "public PartitionKind getKind()"
desc: "Sets the partition algorithm used to calculate the partition id given a partition key."
returns:
description: "the partition algorithm."
type: "<xref href=\"com.azure.cosmos.models.PartitionKind?alt=com.azure.cosmos.models.PartitionKind&text=PartitionKind\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.getPaths()"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.getPaths()"
name: "getPaths()"
nameWithType: "PartitionKeyDefinition.getPaths()"
summary: "Gets the item property paths for the partition key."
syntax: "public List<String> getPaths()"
desc: "Gets the item property paths for the partition key."
returns:
description: "the paths to the item properties that form the partition key."
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.PartitionKeyDefinition.getVersion()"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.getVersion()"
name: "getVersion()"
nameWithType: "PartitionKeyDefinition.getVersion()"
summary: "Gets version."
syntax: "public PartitionKeyDefinitionVersion getVersion()"
desc: "Gets version."
returns:
description: "the <xref uid=\"com.azure.cosmos.models.PartitionKeyDefinitionVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionKeyDefinitionVersion\"></xref>"
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinitionVersion?alt=com.azure.cosmos.models.PartitionKeyDefinitionVersion&text=PartitionKeyDefinitionVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.setKind(com.azure.cosmos.models.PartitionKind)"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.setKind(PartitionKind kind)"
name: "setKind(PartitionKind kind)"
nameWithType: "PartitionKeyDefinition.setKind(PartitionKind kind)"
summary: "Sets the partition algorithm used to calculate the partition id given a partition key."
parameters:
- description: "the partition algorithm."
name: "kind"
type: "<xref href=\"com.azure.cosmos.models.PartitionKind?alt=com.azure.cosmos.models.PartitionKind&text=PartitionKind\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PartitionKeyDefinition setKind(PartitionKind kind)"
desc: "Sets the partition algorithm used to calculate the partition id given a partition key."
returns:
description: "this PartitionKeyDefinition."
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinition?alt=com.azure.cosmos.models.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.setPaths(java.util.List<java.lang.String>)"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.setPaths(List<String> paths)"
name: "setPaths(List<String> paths)"
nameWithType: "PartitionKeyDefinition.setPaths(List<String> paths)"
summary: "Sets the item property paths for the partition key."
parameters:
- description: "the paths to item properties that form the partition key."
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 PartitionKeyDefinition setPaths(List<String> paths)"
desc: "Sets the item property paths for the partition key."
returns:
description: "this PartitionKeyDefinition."
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinition?alt=com.azure.cosmos.models.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKeyDefinition.setVersion(com.azure.cosmos.models.PartitionKeyDefinitionVersion)"
fullName: "com.azure.cosmos.models.PartitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion version)"
name: "setVersion(PartitionKeyDefinitionVersion version)"
nameWithType: "PartitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion version)"
summary: "Sets version."
parameters:
- description: "the version"
name: "version"
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinitionVersion?alt=com.azure.cosmos.models.PartitionKeyDefinitionVersion&text=PartitionKeyDefinitionVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PartitionKeyDefinition setVersion(PartitionKeyDefinitionVersion version)"
desc: "Sets version."
returns:
description: "the version"
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinition?alt=com.azure.cosmos.models.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a partition key definition in the Azure Cosmos DB database service. A partition key definition specifies which item property is used as the partition key in a container that has multiple partitions."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.61.1