-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.microsoft.azure.documentdb.HashPartitionResolver.yml
128 lines (128 loc) · 13.5 KB
/
com.microsoft.azure.documentdb.HashPartitionResolver.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
127
128
### YamlMime:JavaType
uid: "com.microsoft.azure.documentdb.HashPartitionResolver"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver"
name: "HashPartitionResolver"
nameWithType: "HashPartitionResolver"
summary: "Hash<wbr>Partition<wbr>Resolver implements partitioning based on the value of a hash function, allowing you to evenly distribute requests and data across a number of partitions by implementing Partition<wbr>Resolver interface in the Azure Cosmos DB database service."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public class **HashPartitionResolver**</br> implements <xref href=\"com.microsoft.azure.documentdb.PartitionResolver?alt=com.microsoft.azure.documentdb.PartitionResolver&text=PartitionResolver\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(com.microsoft.azure.documentdb.PartitionKeyExtractor,java.lang.Iterable<java.lang.String>)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks)"
name: "HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks)"
nameWithType: "HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks)"
summary: "Hash<wbr>Partition<wbr>Resolver constructor taking in the Partition<wbr>Key<wbr>Extractor and collection links with default number of virtual nodes per collection(128) and default hash generator(Murmur<wbr>Hash3)"
parameters:
- description: "an instance of class that implements PartitionKeyExtractor interface"
name: "partitionKeyExtractor"
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyExtractor?alt=com.microsoft.azure.documentdb.PartitionKeyExtractor&text=PartitionKeyExtractor\" data-throw-if-not-resolved=\"False\" />"
- description: "the links of collections participating in partitioning"
name: "collectionLinks"
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks)"
desc: "HashPartitionResolver constructor taking in the PartitionKeyExtractor and collection links with default number of virtual nodes per collection(128) and default hash generator(MurmurHash3)"
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(com.microsoft.azure.documentdb.PartitionKeyExtractor,java.lang.Iterable<java.lang.String>,com.microsoft.azure.documentdb.HashGenerator)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, HashGenerator hashGenerator)"
name: "HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, HashGenerator hashGenerator)"
nameWithType: "HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, HashGenerator hashGenerator)"
summary: "Hash<wbr>Partition<wbr>Resolver constructor taking in the Partition<wbr>Key<wbr>Extractor, collection Links, hash generator with default number of virtual nodes per collection(128)"
parameters:
- description: "an instance of class that implements PartitionKeyExtractor interface"
name: "partitionKeyExtractor"
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyExtractor?alt=com.microsoft.azure.documentdb.PartitionKeyExtractor&text=PartitionKeyExtractor\" data-throw-if-not-resolved=\"False\" />"
- description: "the links of collections participating in partitioning"
name: "collectionLinks"
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- description: "hash generator used for hashing"
name: "hashGenerator"
type: "<xref href=\"com.microsoft.azure.documentdb.HashGenerator?alt=com.microsoft.azure.documentdb.HashGenerator&text=HashGenerator\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, HashGenerator hashGenerator)"
desc: "HashPartitionResolver constructor taking in the PartitionKeyExtractor, collection Links, hash generator with default number of virtual nodes per collection(128)"
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(com.microsoft.azure.documentdb.PartitionKeyExtractor,java.lang.Iterable<java.lang.String>,int)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection)"
name: "HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection)"
nameWithType: "HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection)"
summary: "Hash<wbr>Partition<wbr>Resolver constructor taking in the Partition<wbr>Key<wbr>Extractor, collection Links, number of virtual nodes per collection and default hash generator(Murmur<wbr>Hash3)"
parameters:
- description: "an instance of class that implements PartitionKeyExtractor interface"
name: "partitionKeyExtractor"
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyExtractor?alt=com.microsoft.azure.documentdb.PartitionKeyExtractor&text=PartitionKeyExtractor\" data-throw-if-not-resolved=\"False\" />"
- description: "the links of collections participating in partitioning"
name: "collectionLinks"
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- description: "number of virtual nodes per collection"
name: "numberOfVirtualNodesPerCollection"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection)"
desc: "HashPartitionResolver constructor taking in the PartitionKeyExtractor, collection Links, number of virtual nodes per collection and default hash generator(MurmurHash3)"
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(com.microsoft.azure.documentdb.PartitionKeyExtractor,java.lang.Iterable<java.lang.String>,int,com.microsoft.azure.documentdb.HashGenerator)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection, HashGenerator hashGenerator)"
name: "HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection, HashGenerator hashGenerator)"
nameWithType: "HashPartitionResolver.HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection, HashGenerator hashGenerator)"
summary: "Hash<wbr>Partition<wbr>Resolver constructor taking in the Partition<wbr>Key<wbr>Extractor, collection Links, hash generator and number of virtual nodes per collection"
parameters:
- description: "an instance of class that implements PartitionKeyExtractor interface"
name: "partitionKeyExtractor"
type: "<xref href=\"com.microsoft.azure.documentdb.PartitionKeyExtractor?alt=com.microsoft.azure.documentdb.PartitionKeyExtractor&text=PartitionKeyExtractor\" data-throw-if-not-resolved=\"False\" />"
- description: "the links of collections participating in partitioning"
name: "collectionLinks"
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- description: "number of virtual nodes per collection"
name: "numberOfVirtualNodesPerCollection"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "hash generator used for hashing"
name: "hashGenerator"
type: "<xref href=\"com.microsoft.azure.documentdb.HashGenerator?alt=com.microsoft.azure.documentdb.HashGenerator&text=HashGenerator\" data-throw-if-not-resolved=\"False\" />"
syntax: "public HashPartitionResolver(PartitionKeyExtractor partitionKeyExtractor, Iterable<String> collectionLinks, int numberOfVirtualNodesPerCollection, HashGenerator hashGenerator)"
desc: "HashPartitionResolver constructor taking in the PartitionKeyExtractor, collection Links, hash generator and number of virtual nodes per collection"
methods:
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.resolveForCreate(java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.resolveForCreate(Object document)"
name: "resolveForCreate(Object document)"
nameWithType: "HashPartitionResolver.resolveForCreate(Object document)"
summary: "Resolves the collection for creating the document based on the partition key."
parameters:
- description: "the document to be created"
name: "document"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String resolveForCreate(Object document)"
desc: "Resolves the collection for creating the document based on the partition key."
returns:
description: "collection Self link or Name based link which should handle the Create operation."
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.documentdb.HashPartitionResolver.resolveForRead(java.lang.Object)"
fullName: "com.microsoft.azure.documentdb.HashPartitionResolver.resolveForRead(Object partitionKey)"
name: "resolveForRead(Object partitionKey)"
nameWithType: "HashPartitionResolver.resolveForRead(Object partitionKey)"
summary: "Resolves the collection for reading/querying the documents based on the partition key."
parameters:
- description: "the partition key value"
name: "partitionKey"
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Iterable<String> resolveForRead(Object partitionKey)"
desc: "Resolves the collection for reading/querying the documents based on the partition key."
returns:
description: "collection Self link(s) or Name based link(s) which should handle the Read operation"
type: "<xref href=\"java.lang.Iterable?alt=java.lang.Iterable&text=Iterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "HashPartitionResolver implements partitioning based on the value of a hash function, allowing you to evenly distribute requests and data across a number of partitions by implementing PartitionResolver interface in the Azure Cosmos DB database service."
implements:
- "<xref href=\"com.microsoft.azure.documentdb.PartitionResolver?alt=com.microsoft.azure.documentdb.PartitionResolver&text=PartitionResolver\" data-throw-if-not-resolved=\"False\" />"
metadata: {}
package: "com.microsoft.azure.documentdb"
artifact: com.microsoft.azure:azure-documentdb:2.4.7