129 строки
14 KiB
YAML
129 строки
14 KiB
YAML
### 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
|