205 строки
17 KiB
YAML
205 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.PartitionKeyRange"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange"
|
|
name: "PartitionKeyRange"
|
|
nameWithType: "PartitionKeyRange"
|
|
summary: "Represent a partition key range in the Azure Cosmos DB database service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getCollection&text=<T>getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>getObject(java.lang.String,java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>getObject&text=<T>getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>set(java.lang.String,T)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>set&text=<T>set\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.<T>toObject(java.lang.Class<T>)?alt=com.microsoft.azure.documentdb.JsonSerializable.<T>toObject&text=<T>toObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.get(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.get&text=get\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getBoolean(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getBoolean&text=getBoolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getCollection(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getCollection&text=getCollection\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getDouble(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getDouble&text=getDouble\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getHashMap()?alt=com.microsoft.azure.documentdb.JsonSerializable.getHashMap&text=getHashMap\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getInt(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getInt&text=getInt\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLogger()?alt=com.microsoft.azure.documentdb.JsonSerializable.getLogger&text=getLogger\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getLong(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getLong&text=getLong\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getMapper()?alt=com.microsoft.azure.documentdb.JsonSerializable.getMapper&text=getMapper\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObject(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObject&text=getObject\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(java.util.Collection<java.lang.String>)?alt=com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath&text=getObjectByPath\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.getString(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.getString&text=getString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.has(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.has&text=has\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.remove(java.lang.String)?alt=com.microsoft.azure.documentdb.JsonSerializable.remove&text=remove\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson()?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toJson(com.microsoft.azure.documentdb.SerializationFormattingPolicy)?alt=com.microsoft.azure.documentdb.JsonSerializable.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString()?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.JsonSerializable.toString(int)?alt=com.microsoft.azure.documentdb.JsonSerializable.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getETag()?alt=com.microsoft.azure.documentdb.Resource.getETag&text=getETag\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getId()?alt=com.microsoft.azure.documentdb.Resource.getId&text=getId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getResourceId()?alt=com.microsoft.azure.documentdb.Resource.getResourceId&text=getResourceId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getSelfLink()?alt=com.microsoft.azure.documentdb.Resource.getSelfLink&text=getSelfLink\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.getTimestamp()?alt=com.microsoft.azure.documentdb.Resource.getTimestamp&text=getTimestamp\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setId&text=setId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Resource.setResourceId(java.lang.String)?alt=com.microsoft.azure.documentdb.Resource.setResourceId&text=setResourceId\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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.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: "public class **PartitionKeyRange**</br> extends <xref href=\"com.microsoft.azure.documentdb.Resource?alt=com.microsoft.azure.documentdb.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange()"
|
|
name: "PartitionKeyRange()"
|
|
nameWithType: "PartitionKeyRange.PartitionKeyRange()"
|
|
summary: "Initialize a partition key range object."
|
|
syntax: "public PartitionKeyRange()"
|
|
desc: "Initialize a partition key range object."
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(String jsonString)"
|
|
name: "PartitionKeyRange(String jsonString)"
|
|
nameWithType: "PartitionKeyRange.PartitionKeyRange(String jsonString)"
|
|
summary: "Initialize a partition key range object from json string."
|
|
parameters:
|
|
- description: "the json string that represents the partition key range\n object."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PartitionKeyRange(String jsonString)"
|
|
desc: "Initialize a partition key range object from json string."
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(String id, String minInclusive, String maxExclusive)"
|
|
name: "PartitionKeyRange(String id, String minInclusive, String maxExclusive)"
|
|
nameWithType: "PartitionKeyRange.PartitionKeyRange(String id, String minInclusive, String maxExclusive)"
|
|
parameters:
|
|
- name: "id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "minInclusive"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "maxExclusive"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PartitionKeyRange(String id, String minInclusive, String maxExclusive)"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.PartitionKeyRange(JSONObject jsonObject)"
|
|
name: "PartitionKeyRange(JSONObject jsonObject)"
|
|
nameWithType: "PartitionKeyRange.PartitionKeyRange(JSONObject jsonObject)"
|
|
summary: "Initialize a partition key range object from json object."
|
|
parameters:
|
|
- description: "the json object that represents the partition key range\n object."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PartitionKeyRange(JSONObject jsonObject)"
|
|
desc: "Initialize a partition key range object from json object."
|
|
fields:
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.MASTER_PARTITION_KEY_RANGE_ID"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.MASTER_PARTITION_KEY_RANGE_ID"
|
|
name: "MASTER_PARTITION_KEY_RANGE_ID"
|
|
nameWithType: "PartitionKeyRange.MASTER_PARTITION_KEY_RANGE_ID"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "M"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String MASTER_PARTITION_KEY_RANGE_ID"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
name: "MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
nameWithType: "PartitionKeyRange.MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "FF"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String MAXIMUM_EXCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
name: "MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
nameWithType: "PartitionKeyRange.MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String MINIMUM_INCLUSIVE_EFFECTIVE_PARTITION_KEY"
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.equals(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.equals(Object obj)"
|
|
name: "equals(Object obj)"
|
|
nameWithType: "PartitionKeyRange.equals(Object obj)"
|
|
overridden: "java.lang.Object.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "obj"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public boolean equals(Object obj)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.getMaxExclusive()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.getMaxExclusive()"
|
|
name: "getMaxExclusive()"
|
|
nameWithType: "PartitionKeyRange.getMaxExclusive()"
|
|
syntax: "public String getMaxExclusive()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.getMinInclusive()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.getMinInclusive()"
|
|
name: "getMinInclusive()"
|
|
nameWithType: "PartitionKeyRange.getMinInclusive()"
|
|
syntax: "public String getMinInclusive()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.getParents()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.getParents()"
|
|
name: "getParents()"
|
|
nameWithType: "PartitionKeyRange.getParents()"
|
|
summary: "Used internally to indicate the ID of the parent range"
|
|
syntax: "public Collection<String> getParents()"
|
|
desc: "Used internally to indicate the ID of the parent range"
|
|
returns:
|
|
description: "a list partition key range ID"
|
|
type: "<xref href=\"java.util.Collection?alt=java.util.Collection&text=Collection\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.hashCode()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "PartitionKeyRange.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.microsoft.azure.documentdb.PartitionKeyRange.setMaxExclusive(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.setMaxExclusive(String maxExclusive)"
|
|
name: "setMaxExclusive(String maxExclusive)"
|
|
nameWithType: "PartitionKeyRange.setMaxExclusive(String maxExclusive)"
|
|
parameters:
|
|
- name: "maxExclusive"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMaxExclusive(String maxExclusive)"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.setMinInclusive(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.setMinInclusive(String minInclusive)"
|
|
name: "setMinInclusive(String minInclusive)"
|
|
nameWithType: "PartitionKeyRange.setMinInclusive(String minInclusive)"
|
|
parameters:
|
|
- name: "minInclusive"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMinInclusive(String minInclusive)"
|
|
- uid: "com.microsoft.azure.documentdb.PartitionKeyRange.toRange()"
|
|
fullName: "com.microsoft.azure.documentdb.PartitionKeyRange.toRange()"
|
|
name: "toRange()"
|
|
nameWithType: "PartitionKeyRange.toRange()"
|
|
syntax: "public Range<String> toRange()"
|
|
returns:
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.internal.routing.Range?alt=com.microsoft.azure.documentdb.internal.routing.Range&text=Range\" 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: "Represent a partition key range in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|