176 строки
10 KiB
YAML
176 строки
10 KiB
YAML
### YamlMime:JavaType
|
||
constructors:
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy()
|
||
name: IndexingPolicy()
|
||
nameWithType: IndexingPolicy.IndexingPolicy()
|
||
summary: <p>Constructor. </p>
|
||
syntax: public IndexingPolicy()
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy()
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(Index[] defaultIndexOverrides)
|
||
name: IndexingPolicy(Index[] defaultIndexOverrides)
|
||
nameWithType: IndexingPolicy.IndexingPolicy(Index[] defaultIndexOverrides)
|
||
parameters:
|
||
- description: <p>comma separated set of indexes that serve as default index specifications for the root path. </p>
|
||
name: defaultIndexOverrides
|
||
type: <xref href="com.microsoft.azure.documentdb.Index?alt=com.microsoft.azure.documentdb.Index&text=Index" data-throw-if-not-resolved="False"/> []
|
||
summary: "<p>Initializes a new instance of the IndexingPolicy class with the specified set of indexes as default index specifications for the root path. </p>\r\n<p>The following example shows how to override the default indexingPolicy for root path: <pre><code>HashIndex hashIndexOverride = Index.Hash(DataType.String, 5);\r\n RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);\r\n SpatialIndex spatialIndexOverride = Index.Spatial(DataType.Point);\r\n \r\n IndexingPolicy indexingPolicy = new IndexingPolicy(hashIndexOverride, rangeIndexOverride, spatialIndexOverride);\r\n </code></pre></p>\r\n<p>If you would like to just override the indexingPolicy for Numbers you can specify just that: <pre><code>RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);\r\n \r\n IndexingPolicy indexingPolicy = new IndexingPolicy(rangeIndexOverride);\r\n </code></pre></p>\r\n<p></p>"
|
||
syntax: public IndexingPolicy(Index[] defaultIndexOverrides)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(Index [])
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(JSONObject jsonObject)
|
||
name: IndexingPolicy(JSONObject jsonObject)
|
||
nameWithType: IndexingPolicy.IndexingPolicy(JSONObject jsonObject)
|
||
parameters:
|
||
- description: <p>the json object that represents the indexing policy. </p>
|
||
name: jsonObject
|
||
type: <xref href="JSONObject?alt=JSONObject&text=JSONObject" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax: public IndexingPolicy(JSONObject jsonObject)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(JSONObject)
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(String jsonString)
|
||
name: IndexingPolicy(String jsonString)
|
||
nameWithType: IndexingPolicy.IndexingPolicy(String jsonString)
|
||
parameters:
|
||
- description: <p>the json string that represents the indexing policy. </p>
|
||
name: jsonString
|
||
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Constructor.</p>
|
||
|
||
<p></p>
|
||
syntax: public IndexingPolicy(String jsonString)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.IndexingPolicy(String)
|
||
inheritances:
|
||
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
||
- <xref href="Serializable" data-throw-if-not-resolved="False"/>
|
||
- <xref href="com.microsoft.azure.documentdb.JsonSerializable?alt=com.microsoft.azure.documentdb.JsonSerializable&text=JsonSerializable" data-throw-if-not-resolved="False"/>
|
||
inheritedMembers:
|
||
- com.microsoft.azure.documentdb.JsonSerializable.get(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getBoolean(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getCollection(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getDouble(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getHashMap()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getInt(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getLogger()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getLong(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getMapper()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getObject(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getObjectByPath(Collection<String>)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.getString(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.has(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(String,ObjectMapper)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.JsonSerializable(JSONObject)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.remove(String)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.toJson()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.toJson(SerializationFormattingPolicy)
|
||
- com.microsoft.azure.documentdb.JsonSerializable.toString()
|
||
- com.microsoft.azure.documentdb.JsonSerializable.toString(int)
|
||
methods:
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.getAutomatic()
|
||
name: getAutomatic()
|
||
nameWithType: IndexingPolicy.getAutomatic()
|
||
returns:
|
||
description: <p>the automatic </p>
|
||
type: <xref href="Boolean?alt=Boolean&text=Boolean" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Gets whether automatic indexing is enabled for a collection. </p>
|
||
|
||
<p>In automatic indexing, documents can be explicitly excluded from indexing using RequestOptions. In manual indexing, documents can be explicitly included.</p>
|
||
|
||
<p></p>
|
||
syntax: public Boolean getAutomatic()
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.getAutomatic()
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.getExcludedPaths()
|
||
name: getExcludedPaths()
|
||
nameWithType: IndexingPolicy.getExcludedPaths()
|
||
returns:
|
||
description: <p>the excluded paths. </p>
|
||
type: Collection<<xref href="com.microsoft.azure.documentdb.ExcludedPath?alt=com.microsoft.azure.documentdb.ExcludedPath&text=ExcludedPath" data-throw-if-not-resolved="False"/>>
|
||
summary: >-
|
||
<p>Gets the paths that are not indexed.</p>
|
||
|
||
<p></p>
|
||
syntax: public Collection<ExcludedPath> getExcludedPaths()
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.getExcludedPaths()
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.getIncludedPaths()
|
||
name: getIncludedPaths()
|
||
nameWithType: IndexingPolicy.getIncludedPaths()
|
||
returns:
|
||
description: <p>the included paths. </p>
|
||
type: Collection<<xref href="com.microsoft.azure.documentdb.IncludedPath?alt=com.microsoft.azure.documentdb.IncludedPath&text=IncludedPath" data-throw-if-not-resolved="False"/>>
|
||
summary: >-
|
||
<p>Gets the paths that are chosen to be indexed by the user.</p>
|
||
|
||
<p></p>
|
||
syntax: public Collection<IncludedPath> getIncludedPaths()
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.getIncludedPaths()
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.getIndexingMode()
|
||
name: getIndexingMode()
|
||
nameWithType: IndexingPolicy.getIndexingMode()
|
||
returns:
|
||
description: <p>the indexing mode. </p>
|
||
type: <xref href="com.microsoft.azure.documentdb.IndexingMode?alt=com.microsoft.azure.documentdb.IndexingMode&text=IndexingMode" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Gets the indexing mode (consistent or lazy).</p>
|
||
|
||
<p></p>
|
||
syntax: public IndexingMode getIndexingMode()
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.getIndexingMode()
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.setAutomatic(boolean automatic)
|
||
name: setAutomatic(boolean automatic)
|
||
nameWithType: IndexingPolicy.setAutomatic(boolean automatic)
|
||
parameters:
|
||
- description: <p>the automatic </p>
|
||
name: automatic
|
||
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Sets whether automatic indexing is enabled for a collection. </p>
|
||
|
||
<p>In automatic indexing, documents can be explicitly excluded from indexing using RequestOptions. In manual indexing, documents can be explicitly included.</p>
|
||
|
||
<p></p>
|
||
syntax: public void setAutomatic(boolean automatic)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.setAutomatic(boolean)
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.setExcludedPaths(Collection<ExcludedPath> excludedPaths)
|
||
name: setExcludedPaths(Collection<ExcludedPath> excludedPaths)
|
||
nameWithType: IndexingPolicy.setExcludedPaths(Collection<ExcludedPath> excludedPaths)
|
||
parameters:
|
||
- name: excludedPaths
|
||
type: Collection<<xref href="com.microsoft.azure.documentdb.ExcludedPath?alt=com.microsoft.azure.documentdb.ExcludedPath&text=ExcludedPath" data-throw-if-not-resolved="False"/>>
|
||
syntax: public void setExcludedPaths(Collection<ExcludedPath> excludedPaths)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.setExcludedPaths(Collection<ExcludedPath>)
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.setIncludedPaths(Collection<IncludedPath> includedPaths)
|
||
name: setIncludedPaths(Collection<IncludedPath> includedPaths)
|
||
nameWithType: IndexingPolicy.setIncludedPaths(Collection<IncludedPath> includedPaths)
|
||
parameters:
|
||
- name: includedPaths
|
||
type: Collection<<xref href="com.microsoft.azure.documentdb.IncludedPath?alt=com.microsoft.azure.documentdb.IncludedPath&text=IncludedPath" data-throw-if-not-resolved="False"/>>
|
||
syntax: public void setIncludedPaths(Collection<IncludedPath> includedPaths)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.setIncludedPaths(Collection<IncludedPath>)
|
||
- fullName: com.microsoft.azure.documentdb.IndexingPolicy.setIndexingMode(IndexingMode indexingMode)
|
||
name: setIndexingMode(IndexingMode indexingMode)
|
||
nameWithType: IndexingPolicy.setIndexingMode(IndexingMode indexingMode)
|
||
parameters:
|
||
- description: <p>the indexing mode. </p>
|
||
name: indexingMode
|
||
type: <xref href="com.microsoft.azure.documentdb.IndexingMode?alt=com.microsoft.azure.documentdb.IndexingMode&text=IndexingMode" data-throw-if-not-resolved="False"/>
|
||
summary: >-
|
||
<p>Sets the indexing mode (consistent or lazy).</p>
|
||
|
||
<p></p>
|
||
syntax: public void setIndexingMode(IndexingMode indexingMode)
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy.setIndexingMode(IndexingMode)
|
||
nameWithType: IndexingPolicy
|
||
syntax: public class IndexingPolicy extends JsonSerializable
|
||
type: class
|
||
uid: com.microsoft.azure.documentdb.IndexingPolicy
|
||
fullName: com.microsoft.azure.documentdb.IndexingPolicy
|
||
name: IndexingPolicy
|
||
package: com.microsoft.azure.documentdb
|
||
summary: <p>Represents the indexing policy configuration for a collection in the Azure Cosmos DB database service. </p>
|
||
metadata: {}
|