-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.cosmos.models.PartitionKey.yml
126 lines (126 loc) · 7.93 KB
/
com.azure.cosmos.models.PartitionKey.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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
### YamlMime:JavaType
uid: "com.azure.cosmos.models.PartitionKey"
fullName: "com.azure.cosmos.models.PartitionKey"
name: "PartitionKey"
nameWithType: "PartitionKey"
summary: "Represents a partition key value 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 class **PartitionKey**"
constructors:
- uid: "com.azure.cosmos.models.PartitionKey.PartitionKey(java.lang.Object)"
fullName: "com.azure.cosmos.models.PartitionKey.PartitionKey(Object key)"
name: "PartitionKey(Object key)"
nameWithType: "PartitionKey.PartitionKey(Object key)"
summary: "Constructor."
parameters:
- description: "the value of the partition key."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public PartitionKey(Object key)"
desc: "Constructor. CREATE a new instance of the PartitionKey object."
fields:
- uid: "com.azure.cosmos.models.PartitionKey.NONE"
fullName: "com.azure.cosmos.models.PartitionKey.NONE"
name: "NONE"
nameWithType: "PartitionKey.NONE"
summary: "Partition key that represents no partition key."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final PartitionKey NONE"
desc: "Partition key that represents no partition key."
methods:
- uid: "com.azure.cosmos.models.PartitionKey.equals(java.lang.Object)"
fullName: "com.azure.cosmos.models.PartitionKey.equals(Object other)"
name: "equals(Object other)"
nameWithType: "PartitionKey.equals(Object other)"
summary: "Overrides the Equal operator for object comparisons between two instances of <xref uid=\"com.azure.cosmos.models.PartitionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionKey\"></xref>"
overridden: "java.lang.Object.equals(java.lang.Object)"
parameters:
- description: "The object to compare with."
name: "other"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
syntax: "public boolean equals(Object other)"
desc: "Overrides the Equal operator for object comparisons between two instances of <xref uid=\"com.azure.cosmos.models.PartitionKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionKey\"></xref>"
returns:
description: "True if two object instance are considered equal."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKey.fromItem(java.util.Map<java.lang.String,java.lang.Object>,com.azure.cosmos.models.PartitionKeyDefinition)"
fullName: "com.azure.cosmos.models.PartitionKey.fromItem(Map<String,Object> item, PartitionKeyDefinition partitionKeyDefinition)"
name: "fromItem(Map<String,Object> item, PartitionKeyDefinition partitionKeyDefinition)"
nameWithType: "PartitionKey.fromItem(Map<String,Object> item, PartitionKeyDefinition partitionKeyDefinition)"
summary: "Returns the Partition<wbr>Key extracted from the item"
modifiers:
- "static"
parameters:
- description: "The JsonSerializable object to get the PartitionKey value from"
name: "item"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
- description: "The PartitionKeyDefinition to use to extract the PartitionKey value"
name: "partitionKeyDefinition"
type: "<xref href=\"com.azure.cosmos.models.PartitionKeyDefinition?alt=com.azure.cosmos.models.PartitionKeyDefinition&text=PartitionKeyDefinition\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static PartitionKey fromItem(Map<String,Object> item, PartitionKeyDefinition partitionKeyDefinition)"
desc: "Returns the PartitionKey extracted from the item"
returns:
description: "The PartitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKey.fromObjectArray(java.lang.Object[],boolean)"
fullName: "com.azure.cosmos.models.PartitionKey.fromObjectArray(Object[] values, boolean strict)"
name: "fromObjectArray(Object[] values, boolean strict)"
nameWithType: "PartitionKey.fromObjectArray(Object[] values, boolean strict)"
summary: "Returns the Partition<wbr>Key from an array of objects that is generated by Partition<wbr>Key<wbr>Internal"
modifiers:
- "static"
parameters:
- description: "The object array of values to construct the PartitionKey with"
name: "values"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>[]"
- description: "The boolean value for if to use strict on object types"
name: "strict"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static PartitionKey fromObjectArray(Object[] values, boolean strict)"
desc: "Returns the PartitionKey from an array of objects that is generated by PartitionKeyInternal"
returns:
description: "The PartitionKey"
type: "<xref href=\"com.azure.cosmos.models.PartitionKey?alt=com.azure.cosmos.models.PartitionKey&text=PartitionKey\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKey.hashCode()"
fullName: "com.azure.cosmos.models.PartitionKey.hashCode()"
name: "hashCode()"
nameWithType: "PartitionKey.hashCode()"
overridden: "java.lang.Object.hashCode()"
syntax: "public int hashCode()"
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.models.PartitionKey.toString()"
fullName: "com.azure.cosmos.models.PartitionKey.toString()"
name: "toString()"
nameWithType: "PartitionKey.toString()"
summary: "Serialize the Partition<wbr>Key object to a JSON string."
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
desc: "Serialize the PartitionKey object to a JSON string."
returns:
description: "the string representation of this PartitionKey object."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Represents a partition key value in the Azure Cosmos DB database service. A partition key identifies the partition where the item is stored in."
metadata: {}
package: "com.azure.cosmos.models"
artifact: com.azure:azure-cosmos:4.62.0