943 строки
36 KiB
YAML
943 строки
36 KiB
YAML
### YamlMime:ManagedReference
|
||
items:
|
||
- uid: com.microsoft.azure.documentdb._range_index
|
||
id: _range_index
|
||
parent: com.microsoft.azure.documentdb
|
||
children:
|
||
- com.microsoft.azure.documentdb._range_index.getDataType()
|
||
- com.microsoft.azure.documentdb._range_index.getPrecision()
|
||
- com.microsoft.azure.documentdb._range_index.RangeIndex(DataType)
|
||
- com.microsoft.azure.documentdb._range_index.RangeIndex(DataType,int)
|
||
- com.microsoft.azure.documentdb._range_index.RangeIndex(JSONObject)
|
||
- com.microsoft.azure.documentdb._range_index.RangeIndex(String)
|
||
- com.microsoft.azure.documentdb._range_index.setDataType(DataType)
|
||
- com.microsoft.azure.documentdb._range_index.setPrecision(int)
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: RangeIndex
|
||
nameWithType: RangeIndex
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex
|
||
type: Class
|
||
source:
|
||
remote: &o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
branch: master
|
||
repo: https://github.com/Azure/azure-documentdb-java-pr
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 10
|
||
package: com.microsoft.azure.documentdb
|
||
summary: <p>Represents a range index in the Azure Cosmos DB database service. </p>
|
||
syntax:
|
||
content: public class RangeIndex extends Index
|
||
inheritance:
|
||
- java.lang.Object
|
||
- Serializable
|
||
- com.microsoft.azure.documentdb._json_serializable
|
||
- com.microsoft.azure.documentdb._index
|
||
inheritedMembers:
|
||
- com.microsoft.azure.documentdb._json_serializable.get(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getBoolean(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getCollection(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getDouble(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getHashMap()
|
||
- com.microsoft.azure.documentdb._json_serializable.getInt(String)
|
||
- com.microsoft.azure.documentdb._index.getKind()
|
||
- com.microsoft.azure.documentdb._json_serializable.getLogger()
|
||
- com.microsoft.azure.documentdb._json_serializable.getLong(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getMapper()
|
||
- com.microsoft.azure.documentdb._json_serializable.getObject(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.getObjectByPath(Collection<String>)
|
||
- com.microsoft.azure.documentdb._json_serializable.getString(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.has(String)
|
||
- com.microsoft.azure.documentdb._index.Hash(DataType)
|
||
- com.microsoft.azure.documentdb._index.Hash(DataType,int)
|
||
- com.microsoft.azure.documentdb._index.Index(IndexKind)
|
||
- com.microsoft.azure.documentdb._index.Index(String,IndexKind)
|
||
- com.microsoft.azure.documentdb._index.Index(JSONObject,IndexKind)
|
||
- com.microsoft.azure.documentdb._json_serializable.JsonSerializable()
|
||
- com.microsoft.azure.documentdb._json_serializable.JsonSerializable(String,ObjectMapper)
|
||
- com.microsoft.azure.documentdb._json_serializable.JsonSerializable(String)
|
||
- com.microsoft.azure.documentdb._json_serializable.JsonSerializable(JSONObject)
|
||
- com.microsoft.azure.documentdb._index.Range(DataType)
|
||
- com.microsoft.azure.documentdb._index.Range(DataType,int)
|
||
- com.microsoft.azure.documentdb._json_serializable.remove(String)
|
||
- com.microsoft.azure.documentdb._index.Spatial(DataType)
|
||
- com.microsoft.azure.documentdb._json_serializable.toJson()
|
||
- com.microsoft.azure.documentdb._json_serializable.toJson(SerializationFormattingPolicy)
|
||
- com.microsoft.azure.documentdb._json_serializable.toString()
|
||
- com.microsoft.azure.documentdb._json_serializable.toString(int)
|
||
- uid: com.microsoft.azure.documentdb._range_index.getDataType()
|
||
id: getDataType()
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: getDataType()
|
||
nameWithType: RangeIndex.getDataType()
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.getDataType()
|
||
overload: com.microsoft.azure.documentdb._range_index.getDataType*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 79
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Gets data type.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public DataType getDataType()
|
||
return:
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>the data type. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.getPrecision()
|
||
id: getPrecision()
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: getPrecision()
|
||
nameWithType: RangeIndex.getPrecision()
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.getPrecision()
|
||
overload: com.microsoft.azure.documentdb._range_index.getPrecision*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 103
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Gets precision.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public int getPrecision()
|
||
return:
|
||
type: f75371fa
|
||
description: <p>the precision. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.RangeIndex(DataType)
|
||
id: RangeIndex(DataType)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: RangeIndex(DataType dataType)
|
||
nameWithType: RangeIndex.RangeIndex(DataType dataType)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.RangeIndex(DataType dataType)
|
||
overload: com.microsoft.azure.documentdb._range_index.RangeIndex*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 26
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Initializes a new instance of the RangeIndex class with specified DataType. </p>
|
||
|
||
<p>Here is an example to instantiate RangeIndex class passing in the DataType: <pre><code>RangeIndex rangeIndex = new RangeIndex(DataType.Number);
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public RangeIndex(DataType dataType)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>the data type. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.RangeIndex(DataType,int)
|
||
id: RangeIndex(DataType,int)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: RangeIndex(DataType dataType, int precision)
|
||
nameWithType: RangeIndex.RangeIndex(DataType dataType, int precision)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.RangeIndex(DataType dataType, int precision)
|
||
overload: com.microsoft.azure.documentdb._range_index.RangeIndex*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 43
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Initializes a new instance of the RangeIndex class with specified DataType and precision. <pre><code>RangeIndex rangeIndex = new RangeIndex(DataType.Number, -1);
|
||
|
||
</code></pre></p>
|
||
syntax:
|
||
content: public RangeIndex(DataType dataType, int precision)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>the data type of the RangeIndex </p>
|
||
- id: precision
|
||
type: f75371fa
|
||
description: <p>the precision of the RangeIndex </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.RangeIndex(JSONObject)
|
||
id: RangeIndex(JSONObject)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: RangeIndex(JSONObject jsonObject)
|
||
nameWithType: RangeIndex.RangeIndex(JSONObject jsonObject)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.RangeIndex(JSONObject jsonObject)
|
||
overload: com.microsoft.azure.documentdb._range_index.RangeIndex*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 66
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Initializes a new instance of the RangeIndex class with json object.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public RangeIndex(JSONObject jsonObject)
|
||
parameters:
|
||
- id: jsonObject
|
||
type: 2b3125a5
|
||
description: <p>the json object that represents the index. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.RangeIndex(String)
|
||
id: RangeIndex(String)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: RangeIndex(String jsonString)
|
||
nameWithType: RangeIndex.RangeIndex(String jsonString)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.RangeIndex(String jsonString)
|
||
overload: com.microsoft.azure.documentdb._range_index.RangeIndex*
|
||
type: Constructor
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 54
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Initializes a new instance of the RangeIndex class with json string.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public RangeIndex(String jsonString)
|
||
parameters:
|
||
- id: jsonString
|
||
type: "26831127"
|
||
description: <p>the json string that represents the index. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.setDataType(DataType)
|
||
id: setDataType(DataType)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: setDataType(DataType dataType)
|
||
nameWithType: RangeIndex.setDataType(DataType dataType)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.setDataType(DataType dataType)
|
||
overload: com.microsoft.azure.documentdb._range_index.setDataType*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 94
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Sets data type.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void setDataType(DataType dataType)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>the data type. </p>
|
||
- uid: com.microsoft.azure.documentdb._range_index.setPrecision(int)
|
||
id: setPrecision(int)
|
||
parent: com.microsoft.azure.documentdb._range_index
|
||
href: com.microsoft.azure.documentdb._range_index.yml
|
||
langs:
|
||
- java
|
||
name: setPrecision(int precision)
|
||
nameWithType: RangeIndex.setPrecision(int precision)
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.setPrecision(int precision)
|
||
overload: com.microsoft.azure.documentdb._range_index.setPrecision*
|
||
type: Method
|
||
source:
|
||
remote: *o0
|
||
path: DocumentDB/src/main/java/com/microsoft/azure/documentdb/RangeIndex.java
|
||
startLine: 112
|
||
package: com.microsoft.azure.documentdb
|
||
summary: >-
|
||
<p>Sets precision.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void setPrecision(int precision)
|
||
parameters:
|
||
- id: precision
|
||
type: f75371fa
|
||
description: <p>the precision. </p>
|
||
references:
|
||
- uid: com.microsoft.azure.documentdb._range_index.RangeIndex*
|
||
name: RangeIndex
|
||
nameWithType: RangeIndex.RangeIndex
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.RangeIndex
|
||
package: com.microsoft.azure.documentdb
|
||
- uid: f75371fa
|
||
spec.java:
|
||
- name: int
|
||
fullName: int
|
||
- uid: "26831127"
|
||
spec.java:
|
||
- name: String
|
||
fullName: String
|
||
- uid: 2b3125a5
|
||
spec.java:
|
||
- name: JSONObject
|
||
fullName: JSONObject
|
||
- uid: com.microsoft.azure.documentdb._range_index.getDataType*
|
||
name: getDataType
|
||
nameWithType: RangeIndex.getDataType
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.getDataType
|
||
package: com.microsoft.azure.documentdb
|
||
- uid: com.microsoft.azure.documentdb._range_index.setDataType*
|
||
name: setDataType
|
||
nameWithType: RangeIndex.setDataType
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.setDataType
|
||
package: com.microsoft.azure.documentdb
|
||
- uid: com.microsoft.azure.documentdb._range_index.getPrecision*
|
||
name: getPrecision
|
||
nameWithType: RangeIndex.getPrecision
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.getPrecision
|
||
package: com.microsoft.azure.documentdb
|
||
- uid: com.microsoft.azure.documentdb._range_index.setPrecision*
|
||
name: setPrecision
|
||
nameWithType: RangeIndex.setPrecision
|
||
fullName: com.microsoft.azure.documentdb.RangeIndex.setPrecision
|
||
package: com.microsoft.azure.documentdb
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.get(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: get(String propertyName)
|
||
nameWithType: JsonSerializable.get(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.get(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a property value as Object.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Object get(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: "79317049"
|
||
description: <p>the value of the property. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getBoolean(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getBoolean(String propertyName)
|
||
nameWithType: JsonSerializable.getBoolean(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getBoolean(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a boolean value.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Boolean getBoolean(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: 866c2227
|
||
description: <p>the boolean value. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getCollection(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getCollection(String propertyName)
|
||
nameWithType: JsonSerializable.getCollection(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getCollection(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a JSONObject collection.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Collection<JSONObject> getCollection(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: e8fa48f8
|
||
description: <p>the JSONObject collection. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getDouble(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getDouble(String propertyName)
|
||
nameWithType: JsonSerializable.getDouble(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getDouble(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a double value.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Double getDouble(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: 8dd309d9
|
||
description: <p>the double value. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getHashMap()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getHashMap()
|
||
nameWithType: JsonSerializable.getHashMap()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getHashMap()
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns the propertybag(JSONObject) in a hashMap</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public HashMap<String, Object> getHashMap()
|
||
return:
|
||
type: f39c727f
|
||
description: <p>the HashMap. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getInt(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getInt(String propertyName)
|
||
nameWithType: JsonSerializable.getInt(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getInt(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets an integer value.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Integer getInt(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: 08effaa0
|
||
description: <p>the boolean value </p>
|
||
- uid: com.microsoft.azure.documentdb._index.getKind()
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: getKind()
|
||
nameWithType: Index.getKind()
|
||
fullName: com.microsoft.azure.documentdb.Index.getKind()
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets index kind.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public IndexKind getKind()
|
||
return:
|
||
type: com.microsoft.azure.documentdb._index_kind
|
||
description: <p>the index kind. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getLogger()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getLogger()
|
||
nameWithType: JsonSerializable.getLogger()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getLogger()
|
||
type: Method
|
||
syntax:
|
||
content: protected Logger getLogger()
|
||
return:
|
||
type: ef129195
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getLong(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getLong(String propertyName)
|
||
nameWithType: JsonSerializable.getLong(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getLong(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a long value.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Long getLong(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: 34f09483
|
||
description: <p>the long value </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getMapper()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getMapper()
|
||
nameWithType: JsonSerializable.getMapper()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getMapper()
|
||
type: Method
|
||
syntax:
|
||
content: protected ObjectMapper getMapper()
|
||
return:
|
||
type: 7db3dbca
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getObject(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getObject(String propertyName)
|
||
nameWithType: JsonSerializable.getObject(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getObject(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a JSONObject.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public JSONObject getObject(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: 2b3125a5
|
||
description: <p>the JSONObject. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getObjectByPath(Collection<String>)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getObjectByPath(Collection<String> propertyNames)
|
||
nameWithType: JsonSerializable.getObjectByPath(Collection<String> propertyNames)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(Collection<String> propertyNames)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets the value of a property identified by an array of property names that forms the path.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public Object getObjectByPath(Collection<String> propertyNames)
|
||
parameters:
|
||
- id: propertyNames
|
||
type: 0248867e
|
||
description: <p>that form the path to the the property to get. </p>
|
||
return:
|
||
type: "79317049"
|
||
description: <p>the value of the property. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.getString(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: getString(String propertyName)
|
||
nameWithType: JsonSerializable.getString(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.getString(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets a string value.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String getString(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to get. </p>
|
||
return:
|
||
type: "26831127"
|
||
description: <p>the string value. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.has(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: has(String propertyName)
|
||
nameWithType: JsonSerializable.has(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.has(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Checks whether a property exists.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public boolean has(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to look up. </p>
|
||
return:
|
||
type: 4fc6e284
|
||
description: <p>true if the property exists. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Hash(DataType)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Hash(DataType dataType)
|
||
nameWithType: Index.Hash(DataType dataType)
|
||
fullName: com.microsoft.azure.documentdb.Index.Hash(DataType dataType)
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns an instance of HashIndex class with specified DataType. </p>
|
||
|
||
<p>Here is an example to create HashIndex instance passing in the DataType: <pre><code>HashIndex hashIndex = Index.Hash(DataType.String);
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public static HashIndex Hash(DataType dataType)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>specifies the target data type for the index path specification. </p>
|
||
return:
|
||
type: com.microsoft.azure.documentdb._hash_index
|
||
description: <p>an instance of HashIndex type. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Hash(DataType,int)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Hash(DataType dataType, int precision)
|
||
nameWithType: Index.Hash(DataType dataType, int precision)
|
||
fullName: com.microsoft.azure.documentdb.Index.Hash(DataType dataType, int precision)
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns an instance of HashIndex class with specified DataType and precision. </p>
|
||
|
||
<p>Here is an example to create HashIndex instance passing in the DataType and precision: </p>
|
||
|
||
<p>HashIndex hashIndex = Index.Hash(DataType.String, 3);</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public static HashIndex Hash(DataType dataType, int precision)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>specifies the target data type for the index path specification. </p>
|
||
- id: precision
|
||
type: f75371fa
|
||
description: <p>specifies the precision to be used for the data type associated with this index. </p>
|
||
return:
|
||
type: com.microsoft.azure.documentdb._hash_index
|
||
description: <p>an instance of HashIndex type. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Index(IndexKind)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Index(IndexKind indexKind)
|
||
nameWithType: Index.Index(IndexKind indexKind)
|
||
fullName: com.microsoft.azure.documentdb.Index.Index(IndexKind indexKind)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected Index(IndexKind indexKind)
|
||
parameters:
|
||
- id: indexKind
|
||
type: com.microsoft.azure.documentdb._index_kind
|
||
description: <p>the kind of the index </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Index(String,IndexKind)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Index(String jsonString, IndexKind indexKind)
|
||
nameWithType: Index.Index(String jsonString, IndexKind indexKind)
|
||
fullName: com.microsoft.azure.documentdb.Index.Index(String jsonString, IndexKind indexKind)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected Index(String jsonString, IndexKind indexKind)
|
||
parameters:
|
||
- id: jsonString
|
||
type: "26831127"
|
||
description: <p>the json string that represents the index. </p>
|
||
- id: indexKind
|
||
type: com.microsoft.azure.documentdb._index_kind
|
||
description: <p>the kind of the index </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Index(JSONObject,IndexKind)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Index(JSONObject jsonObject, IndexKind indexKind)
|
||
nameWithType: Index.Index(JSONObject jsonObject, IndexKind indexKind)
|
||
fullName: com.microsoft.azure.documentdb.Index.Index(JSONObject jsonObject, IndexKind indexKind)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected Index(JSONObject jsonObject, IndexKind indexKind)
|
||
parameters:
|
||
- id: jsonObject
|
||
type: 2b3125a5
|
||
description: <p>the json object that represents the index. </p>
|
||
- id: indexKind
|
||
type: com.microsoft.azure.documentdb._index_kind
|
||
description: <p>the kind of the index </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.JsonSerializable()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: JsonSerializable()
|
||
nameWithType: JsonSerializable.JsonSerializable()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable()
|
||
type: Constructor
|
||
syntax:
|
||
content: protected JsonSerializable()
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.JsonSerializable(String,ObjectMapper)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: JsonSerializable(String jsonString, ObjectMapper objectMapper)
|
||
nameWithType: JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected JsonSerializable(String jsonString, ObjectMapper objectMapper)
|
||
parameters:
|
||
- id: jsonString
|
||
type: "26831127"
|
||
description: <p>the json string that represents the JsonSerializable. </p>
|
||
- id: objectMapper
|
||
type: 7db3dbca
|
||
description: <p>the custom object mapper </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.JsonSerializable(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: JsonSerializable(String jsonString)
|
||
nameWithType: JsonSerializable.JsonSerializable(String jsonString)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(String jsonString)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected JsonSerializable(String jsonString)
|
||
parameters:
|
||
- id: jsonString
|
||
type: "26831127"
|
||
description: <p>the json string that represents the JsonSerializable. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.JsonSerializable(JSONObject)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: JsonSerializable(JSONObject jsonObject)
|
||
nameWithType: JsonSerializable.JsonSerializable(JSONObject jsonObject)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(JSONObject jsonObject)
|
||
type: Constructor
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: protected JsonSerializable(JSONObject jsonObject)
|
||
parameters:
|
||
- id: jsonObject
|
||
type: 2b3125a5
|
||
description: <p>the json object that represents the JsonSerializable. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Range(DataType)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Range(DataType dataType)
|
||
nameWithType: Index.Range(DataType dataType)
|
||
fullName: com.microsoft.azure.documentdb.Index.Range(DataType dataType)
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns an instance of RangeIndex class with specified DataType. </p>
|
||
|
||
<p>Here is an example to create RangeIndex instance passing in the DataType: <pre><code>RangeIndex rangeIndex = Index.Range(DataType.Number);
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public static RangeIndex Range(DataType dataType)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>the data type. </p>
|
||
return:
|
||
type: com.microsoft.azure.documentdb._range_index
|
||
description: <p>an instance of RangeIndex type. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Range(DataType,int)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Range(DataType dataType, int precision)
|
||
nameWithType: Index.Range(DataType dataType, int precision)
|
||
fullName: com.microsoft.azure.documentdb.Index.Range(DataType dataType, int precision)
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns an instance of RangeIndex class with specified DataType and precision. </p>
|
||
|
||
<p>Here is an example to create RangeIndex instance passing in the DataType and precision: <pre><code>RangeIndex rangeIndex = Index.Range(DataType.Number, -1);
|
||
|
||
</code></pre></p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public static RangeIndex Range(DataType dataType, int precision)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>specifies the target data type for the index path specification. </p>
|
||
- id: precision
|
||
type: f75371fa
|
||
description: <p>specifies the precision to be used for the data type associated with this index. </p>
|
||
return:
|
||
type: com.microsoft.azure.documentdb._range_index
|
||
description: <p>an instance of RangeIndex type. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.remove(String)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: remove(String propertyName)
|
||
nameWithType: JsonSerializable.remove(String propertyName)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.remove(String propertyName)
|
||
type: Method
|
||
summary: >-
|
||
<p>Removes a value by propertyName.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public void remove(String propertyName)
|
||
parameters:
|
||
- id: propertyName
|
||
type: "26831127"
|
||
description: <p>the property to remove. </p>
|
||
- uid: com.microsoft.azure.documentdb._index.Spatial(DataType)
|
||
parent: com.microsoft.azure.documentdb._index
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Spatial(DataType dataType)
|
||
nameWithType: Index.Spatial(DataType dataType)
|
||
fullName: com.microsoft.azure.documentdb.Index.Spatial(DataType dataType)
|
||
type: Method
|
||
summary: >-
|
||
<p>Returns an instance of SpatialIndex class with specified DataType. </p>
|
||
|
||
<p>Here is an example to create SpatialIndex instance passing in the DataType: </p>
|
||
|
||
<p>SpatialIndex spatialIndex = Index.Spatial(DataType.Point);</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public static SpatialIndex Spatial(DataType dataType)
|
||
parameters:
|
||
- id: dataType
|
||
type: com.microsoft.azure.documentdb._data_type
|
||
description: <p>specifies the target data type for the index path specification. </p>
|
||
return:
|
||
type: com.microsoft.azure.documentdb._spatial_index
|
||
description: <p>an instance of SpatialIndex type. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.toJson()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: toJson()
|
||
nameWithType: JsonSerializable.toJson()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.toJson()
|
||
type: Method
|
||
summary: >-
|
||
<p>Converts to a JSON string.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String toJson()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>the JSON string. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.toJson(SerializationFormattingPolicy)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: toJson(SerializationFormattingPolicy formattingPolicy)
|
||
nameWithType: JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy)
|
||
type: Method
|
||
summary: <p>Converts to a JSON string. </p>
|
||
syntax:
|
||
content: public String toJson(SerializationFormattingPolicy formattingPolicy)
|
||
parameters:
|
||
- id: formattingPolicy
|
||
type: com.microsoft.azure.documentdb._serialization_formatting_policy
|
||
description: <p>the formatting policy instance </p>
|
||
return:
|
||
type: "26831127"
|
||
description: <p>the JSON string. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.toString()
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: toString()
|
||
nameWithType: JsonSerializable.toString()
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.toString()
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets Simple String representation of property bag.</p>
|
||
|
||
<p>For proper conversion to json and inclusion of the default values use <xref uid="com.microsoft.azure.documentdb._json_serializable.toJson()" data-throw-if-not-resolved="false">toJson()</xref>.</p>
|
||
|
||
<p></p>
|
||
syntax:
|
||
content: public String toString()
|
||
return:
|
||
type: "26831127"
|
||
description: <p>string representation of property bag. </p>
|
||
- uid: com.microsoft.azure.documentdb._json_serializable.toString(int)
|
||
parent: com.microsoft.azure.documentdb._json_serializable
|
||
href: com.microsoft.azure.documentdb._json_serializable.yml
|
||
name: toString(int indentFactor)
|
||
nameWithType: JsonSerializable.toString(int indentFactor)
|
||
fullName: com.microsoft.azure.documentdb.JsonSerializable.toString(int indentFactor)
|
||
type: Method
|
||
summary: >-
|
||
<p>Gets formatted String representation of property bag.</p>
|
||
|
||
<p>
|
||
|
||
<xrefsect id="deprecated_1_deprecated000030">
|
||
|
||
<xreftitle>Deprecated</xreftitle>
|
||
|
||
<xrefdescription>
|
||
|
||
<p>For proper conversion to json and inclusion of the default values use <xref uid="com.microsoft.azure.documentdb._json_serializable.toJson(SerializationFormattingPolicy)" data-throw-if-not-resolved="false">toJson(SerializationFormattingPolicy)</xref>.</p>
|
||
|
||
</xrefdescription>
|
||
|
||
</xrefsect>
|
||
|
||
</p>
|
||
syntax:
|
||
content: public String toString(int indentFactor)
|
||
parameters:
|
||
- id: indentFactor
|
||
type: f75371fa
|
||
description: <p>formatting indentation factor. </p>
|
||
return:
|
||
type: "26831127"
|
||
description: <p>formatted string representation of property bag.</p>
|
||
- uid: com.microsoft.azure.documentdb._index
|
||
parent: com.microsoft.azure.documentdb
|
||
href: com.microsoft.azure.documentdb._index.yml
|
||
name: Index
|
||
nameWithType: Index
|
||
fullName: com.microsoft.azure.documentdb.Index
|
||
type: Class
|
||
summary: <p>Represents the index of a collection in the Azure Cosmos DB database service. </p>
|
||
syntax:
|
||
content: public class Index extends JsonSerializable
|
||
- uid: com.microsoft.azure.documentdb._data_type
|
||
parent: com.microsoft.azure.documentdb
|
||
href: com.microsoft.azure.documentdb._data_type.yml
|
||
name: DataType
|
||
nameWithType: DataType
|
||
fullName: com.microsoft.azure.documentdb.DataType
|
||
type: Enum
|
||
summary: <p>Data types in the Azure Cosmos DB database service. </p>
|
||
syntax:
|
||
content: public enum DataType
|