com.microsoft.azure.cosmosdb

Class IndexingPolicy

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.IndexingPolicy

All Implemented Interfaces:

Serializable

public final class IndexingPolicy
extends JsonSerializable

Represents the indexing policy configuration for a collection in the Azure Cosmos DB database service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexingPolicy() Constructor.
IndexingPolicy(Index[] defaultIndexOverrides) Initializes a new instance of the IndexingPolicy class with the specified set of indexes as default index specifications for the root path.
IndexingPolicy(org.json.JSONObject jsonObject) Constructor.
IndexingPolicy(String jsonString) Constructor.

Method Summary

Modifier and Type	Method and Description
Boolean	getAutomatic() Gets whether automatic indexing is enabled for a collection.
Collection<ExcludedPath>	getExcludedPaths() Gets the paths that are not indexed.
Collection<IncludedPath>	getIncludedPaths() Gets the paths that are chosen to be indexed by the user.
IndexingMode	getIndexingMode() Gets the indexing mode (consistent or lazy).
void	setAutomatic(boolean automatic) Sets whether automatic indexing is enabled for a collection.
void	setExcludedPaths(Collection<ExcludedPath> excludedPaths)
void	setIncludedPaths(Collection<IncludedPath> includedPaths)
void	setIndexingMode(IndexingMode indexingMode) Sets the indexing mode (consistent or lazy).

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexingPolicy

public IndexingPolicy()

Constructor.

IndexingPolicy

public IndexingPolicy(Index[] defaultIndexOverrides)

Initializes a new instance of the IndexingPolicy class with the specified set of indexes as default index specifications for the root path.

The following example shows how to override the default indexingPolicy for root path:

 
 HashIndex hashIndexOverride = Index.Hash(DataType.String, 5);
 RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);
 SpatialIndex spatialIndexOverride = Index.Spatial(DataType.Point);

 IndexingPolicy indexingPolicy = new IndexingPolicy(hashIndexOverride, rangeIndexOverride, spatialIndexOverride);
 
 

If you would like to just override the indexingPolicy for Numbers you can specify just that:

 
 RangeIndex rangeIndexOverride = Index.Range(DataType.Number, 2);

 IndexingPolicy indexingPolicy = new IndexingPolicy(rangeIndexOverride);
 
 

Parameters:

defaultIndexOverrides - comma separated set of indexes that serve as default index specifications for the root path.

IndexingPolicy

public IndexingPolicy(String jsonString)

Constructor.

Parameters:

jsonString - the json string that represents the indexing policy.

IndexingPolicy

public IndexingPolicy(org.json.JSONObject jsonObject)

Constructor.

Parameters:

jsonObject - the json object that represents the indexing policy.

Method Detail

getAutomatic

public Boolean getAutomatic()

Gets whether automatic indexing is enabled for a collection.

In automatic indexing, documents can be explicitly excluded from indexing using RequestOptions. In manual indexing, documents can be explicitly included.

Returns:

the automatic

setAutomatic

public void setAutomatic(boolean automatic)

Sets whether automatic indexing is enabled for a collection.

In automatic indexing, documents can be explicitly excluded from indexing using RequestOptions. In manual indexing, documents can be explicitly included.

Parameters:

automatic - the automatic

getIndexingMode

public IndexingMode getIndexingMode()

Gets the indexing mode (consistent or lazy).

Returns:

the indexing mode.

setIndexingMode

public void setIndexingMode(IndexingMode indexingMode)

Sets the indexing mode (consistent or lazy).

Parameters:

indexingMode - the indexing mode.

getIncludedPaths

public Collection<IncludedPath> getIncludedPaths()

Gets the paths that are chosen to be indexed by the user.

Returns:

the included paths.

setIncludedPaths

public void setIncludedPaths(Collection<IncludedPath> includedPaths)

getExcludedPaths

public Collection<ExcludedPath> getExcludedPaths()

Gets the paths that are not indexed.

Returns:

the excluded paths.

setExcludedPaths

public void setExcludedPaths(Collection<ExcludedPath> excludedPaths)