153 строки
14 KiB
YAML
153 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.RangeIndex"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex"
|
|
name: "RangeIndex"
|
|
nameWithType: "RangeIndex"
|
|
summary: "Represents a range index 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.Index?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Hash&text=Hash\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType,int)?alt=com.microsoft.azure.documentdb.Index.Hash&text=Hash\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Range&text=Range\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType,int)?alt=com.microsoft.azure.documentdb.Index.Range&text=Range\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.Spatial(com.microsoft.azure.documentdb.DataType)?alt=com.microsoft.azure.documentdb.Index.Spatial&text=Spatial\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.documentdb.Index.getKind()?alt=com.microsoft.azure.documentdb.Index.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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=\"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 final class **RangeIndex**</br> extends <xref href=\"com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(com.microsoft.azure.documentdb.DataType)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(DataType dataType)"
|
|
name: "RangeIndex(DataType dataType)"
|
|
nameWithType: "RangeIndex.RangeIndex(DataType dataType)"
|
|
summary: "Initializes a new instance of the Range<wbr>Index class with specified Data<wbr>Type."
|
|
parameters:
|
|
- description: "the data type."
|
|
name: "dataType"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RangeIndex(DataType dataType)"
|
|
desc: "Initializes a new instance of the RangeIndex class with specified DataType.\n\nHere is an example to instantiate RangeIndex class passing in the DataType:\n\n```java\nRangeIndex rangeIndex = new RangeIndex(DataType.Number);\n```"
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(com.microsoft.azure.documentdb.DataType,int)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(DataType dataType, int precision)"
|
|
name: "RangeIndex(DataType dataType, int precision)"
|
|
nameWithType: "RangeIndex.RangeIndex(DataType dataType, int precision)"
|
|
summary: "Initializes a new instance of the Range<wbr>Index class with specified Data<wbr>Type and precision."
|
|
parameters:
|
|
- description: "the data type of the RangeIndex"
|
|
name: "dataType"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the precision of the RangeIndex"
|
|
name: "precision"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RangeIndex(DataType dataType, int precision)"
|
|
desc: "Initializes a new instance of the RangeIndex class with specified DataType and precision.\n\n```java\nRangeIndex rangeIndex = new RangeIndex(DataType.Number, -1);\n```"
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(java.lang.String)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(String jsonString)"
|
|
name: "RangeIndex(String jsonString)"
|
|
nameWithType: "RangeIndex.RangeIndex(String jsonString)"
|
|
summary: "Initializes a new instance of the Range<wbr>Index class with json string."
|
|
parameters:
|
|
- description: "the json string that represents the index."
|
|
name: "jsonString"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RangeIndex(String jsonString)"
|
|
desc: "Initializes a new instance of the RangeIndex class with json string."
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(org.json.JSONObject)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.RangeIndex(JSONObject jsonObject)"
|
|
name: "RangeIndex(JSONObject jsonObject)"
|
|
nameWithType: "RangeIndex.RangeIndex(JSONObject jsonObject)"
|
|
summary: "Initializes a new instance of the Range<wbr>Index class with json object."
|
|
parameters:
|
|
- description: "the json object that represents the index."
|
|
name: "jsonObject"
|
|
type: "<xref href=\"org.json.JSONObject?alt=org.json.JSONObject&text=JSONObject\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public RangeIndex(JSONObject jsonObject)"
|
|
desc: "Initializes a new instance of the RangeIndex class with json object."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.getDataType()"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.getDataType()"
|
|
name: "getDataType()"
|
|
nameWithType: "RangeIndex.getDataType()"
|
|
summary: "Gets data type."
|
|
syntax: "public DataType getDataType()"
|
|
desc: "Gets data type."
|
|
returns:
|
|
description: "the data type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.getPrecision()"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.getPrecision()"
|
|
name: "getPrecision()"
|
|
nameWithType: "RangeIndex.getPrecision()"
|
|
summary: "Gets precision."
|
|
syntax: "public int getPrecision()"
|
|
desc: "Gets precision."
|
|
returns:
|
|
description: "the precision."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.setDataType(com.microsoft.azure.documentdb.DataType)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.setDataType(DataType dataType)"
|
|
name: "setDataType(DataType dataType)"
|
|
nameWithType: "RangeIndex.setDataType(DataType dataType)"
|
|
summary: "Sets data type."
|
|
parameters:
|
|
- description: "the data type."
|
|
name: "dataType"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.DataType?alt=com.microsoft.azure.documentdb.DataType&text=DataType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setDataType(DataType dataType)"
|
|
desc: "Sets data type."
|
|
- uid: "com.microsoft.azure.documentdb.RangeIndex.setPrecision(int)"
|
|
fullName: "com.microsoft.azure.documentdb.RangeIndex.setPrecision(int precision)"
|
|
name: "setPrecision(int precision)"
|
|
nameWithType: "RangeIndex.setPrecision(int precision)"
|
|
summary: "Sets precision."
|
|
parameters:
|
|
- description: "the precision."
|
|
name: "precision"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setPrecision(int precision)"
|
|
desc: "Sets precision."
|
|
type: "class"
|
|
desc: "Represents a range index in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|