196 строки
16 KiB
YAML
196 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.documentdb.Index"
|
|
fullName: "com.microsoft.azure.documentdb.Index"
|
|
name: "Index"
|
|
nameWithType: "Index"
|
|
summary: "Represents the index of a collection 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\" />"
|
|
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=\"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 abstract class **Index**</br> extends <xref href=\"com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.documentdb.Index.Index(com.microsoft.azure.documentdb.IndexKind)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Index(IndexKind indexKind)"
|
|
name: "Index(IndexKind indexKind)"
|
|
nameWithType: "Index.Index(IndexKind indexKind)"
|
|
summary: "Constructor."
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "the kind of the index"
|
|
name: "indexKind"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexKind?alt=com.microsoft.azure.documentdb.IndexKind&text=IndexKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected Index(IndexKind indexKind)"
|
|
desc: "Constructor."
|
|
- uid: "com.microsoft.azure.documentdb.Index.Index(java.lang.String,com.microsoft.azure.documentdb.IndexKind)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Index(String jsonString, IndexKind indexKind)"
|
|
name: "Index(String jsonString, IndexKind indexKind)"
|
|
nameWithType: "Index.Index(String jsonString, IndexKind indexKind)"
|
|
summary: "Constructor."
|
|
modifiers:
|
|
- "protected"
|
|
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\" />"
|
|
- description: "the kind of the index"
|
|
name: "indexKind"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexKind?alt=com.microsoft.azure.documentdb.IndexKind&text=IndexKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected Index(String jsonString, IndexKind indexKind)"
|
|
desc: "Constructor."
|
|
- uid: "com.microsoft.azure.documentdb.Index.Index(org.json.JSONObject,com.microsoft.azure.documentdb.IndexKind)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Index(JSONObject jsonObject, IndexKind indexKind)"
|
|
name: "Index(JSONObject jsonObject, IndexKind indexKind)"
|
|
nameWithType: "Index.Index(JSONObject jsonObject, IndexKind indexKind)"
|
|
summary: "Constructor."
|
|
modifiers:
|
|
- "protected"
|
|
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\" />"
|
|
- description: "the kind of the index"
|
|
name: "indexKind"
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexKind?alt=com.microsoft.azure.documentdb.IndexKind&text=IndexKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected Index(JSONObject jsonObject, IndexKind indexKind)"
|
|
desc: "Constructor."
|
|
methods:
|
|
- uid: "com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Hash(DataType dataType)"
|
|
name: "Hash(DataType dataType)"
|
|
nameWithType: "Index.Hash(DataType dataType)"
|
|
summary: "Returns an instance of Hash<wbr>Index class with specified Data<wbr>Type."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "specifies the target data type for the index path specification."
|
|
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 static HashIndex Hash(DataType dataType)"
|
|
desc: "Returns an instance of HashIndex class with specified DataType.\n\nHere is an example to create HashIndex instance passing in the DataType:\n\n```java\nHashIndex hashIndex = Index.Hash(DataType.String);\n```"
|
|
returns:
|
|
description: "an instance of HashIndex type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.HashIndex?alt=com.microsoft.azure.documentdb.HashIndex&text=HashIndex\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Index.Hash(com.microsoft.azure.documentdb.DataType,int)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Hash(DataType dataType, int precision)"
|
|
name: "Hash(DataType dataType, int precision)"
|
|
nameWithType: "Index.Hash(DataType dataType, int precision)"
|
|
summary: "Returns an instance of Hash<wbr>Index class with specified Data<wbr>Type and precision."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "specifies the target data type for the index path specification."
|
|
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: "specifies the precision to be used for the data type associated with this index."
|
|
name: "precision"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static HashIndex Hash(DataType dataType, int precision)"
|
|
desc: "Returns an instance of HashIndex class with specified DataType and precision.\n\nHere is an example to create HashIndex instance passing in the DataType and precision:\n\nHashIndex hashIndex = Index.Hash(DataType.String, 3);"
|
|
returns:
|
|
description: "an instance of HashIndex type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.HashIndex?alt=com.microsoft.azure.documentdb.HashIndex&text=HashIndex\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Range(DataType dataType)"
|
|
name: "Range(DataType dataType)"
|
|
nameWithType: "Index.Range(DataType dataType)"
|
|
summary: "Returns an instance of Range<wbr>Index class with specified Data<wbr>Type."
|
|
modifiers:
|
|
- "static"
|
|
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 static RangeIndex Range(DataType dataType)"
|
|
desc: "Returns an instance of RangeIndex class with specified DataType.\n\nHere is an example to create RangeIndex instance passing in the DataType:\n\n```java\nRangeIndex rangeIndex = Index.Range(DataType.Number);\n```"
|
|
returns:
|
|
description: "an instance of RangeIndex type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.RangeIndex?alt=com.microsoft.azure.documentdb.RangeIndex&text=RangeIndex\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Index.Range(com.microsoft.azure.documentdb.DataType,int)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Range(DataType dataType, int precision)"
|
|
name: "Range(DataType dataType, int precision)"
|
|
nameWithType: "Index.Range(DataType dataType, int precision)"
|
|
summary: "Returns an instance of Range<wbr>Index class with specified Data<wbr>Type and precision."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "specifies the target data type for the index path specification."
|
|
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: "specifies the precision to be used for the data type associated with this index."
|
|
name: "precision"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static RangeIndex Range(DataType dataType, int precision)"
|
|
desc: "Returns an instance of RangeIndex class with specified DataType and precision.\n\nHere is an example to create RangeIndex instance passing in the DataType and precision:\n\n```java\nRangeIndex rangeIndex = Index.Range(DataType.Number, -1);\n```"
|
|
returns:
|
|
description: "an instance of RangeIndex type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.RangeIndex?alt=com.microsoft.azure.documentdb.RangeIndex&text=RangeIndex\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Index.Spatial(com.microsoft.azure.documentdb.DataType)"
|
|
fullName: "com.microsoft.azure.documentdb.Index.Spatial(DataType dataType)"
|
|
name: "Spatial(DataType dataType)"
|
|
nameWithType: "Index.Spatial(DataType dataType)"
|
|
summary: "Returns an instance of Spatial<wbr>Index class with specified Data<wbr>Type."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "specifies the target data type for the index path specification."
|
|
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 static SpatialIndex Spatial(DataType dataType)"
|
|
desc: "Returns an instance of SpatialIndex class with specified DataType.\n\nHere is an example to create SpatialIndex instance passing in the DataType:\n\nSpatialIndex spatialIndex = Index.Spatial(DataType.Point);"
|
|
returns:
|
|
description: "an instance of SpatialIndex type."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.SpatialIndex?alt=com.microsoft.azure.documentdb.SpatialIndex&text=SpatialIndex\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.documentdb.Index.getKind()"
|
|
fullName: "com.microsoft.azure.documentdb.Index.getKind()"
|
|
name: "getKind()"
|
|
nameWithType: "Index.getKind()"
|
|
summary: "Gets index kind."
|
|
syntax: "public IndexKind getKind()"
|
|
desc: "Gets index kind."
|
|
returns:
|
|
description: "the index kind."
|
|
type: "<xref href=\"com.microsoft.azure.documentdb.IndexKind?alt=com.microsoft.azure.documentdb.IndexKind&text=IndexKind\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents the index of a collection in the Azure Cosmos DB database service."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.documentdb"
|
|
artifact: com.microsoft.azure:azure-documentdb:2.4.7
|