com.azure.cosmos

Class IndexingPolicy

java.lang.Object

com.azure.cosmos.JsonSerializable

com.azure.cosmos.IndexingPolicy

public final class IndexingPolicy
extends JsonSerializable

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

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.

Method Summary

Modifier and Type	Method and Description
Boolean	getAutomatic() Gets whether automatic indexing is enabled for a collection.
List<List<CompositePath>>	getCompositeIndexes() Gets the composite indexes for additional indexes.
List<ExcludedPath>	getExcludedPaths() Gets the paths that are not indexed.
List<IncludedPath>	getIncludedPaths() Gets the paths that are chosen to be indexed by the user.
IndexingMode	getIndexingMode() Gets the indexing mode (consistent or lazy).
List<SpatialSpec>	getSpatialIndexes() Sets the spatial indexes for additional indexes.
IndexingPolicy	setAutomatic(boolean automatic) Sets whether automatic indexing is enabled for a collection.
IndexingPolicy	setCompositeIndexes(List<List<CompositePath>> compositeIndexes) Sets the composite indexes for additional indexes.
IndexingPolicy	setExcludedPaths(List<ExcludedPath> excludedPaths)
void	setIncludedPaths(List<IncludedPath> includedPaths)
IndexingPolicy	setIndexingMode(IndexingMode indexingMode) Sets the indexing mode (consistent or lazy).
IndexingPolicy	setSpatialIndexes(List<SpatialSpec> spatialIndexes) Sets the spatial indexes for additional indexes.

Methods inherited from class com.azure.cosmos.JsonSerializable

get, getBoolean, getCollection, getDouble, getInt, getList, getLogger, getLong, getMap, getObject, getObjectByPath, getString, has, 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:

Parameters:

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

Throws:

IllegalArgumentException - thrown if an error occurs

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 IndexingPolicy 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

Returns:

the Indexing Policy.

getIndexingMode

public IndexingMode getIndexingMode()

Gets the indexing mode (consistent or lazy).

Returns:

the indexing mode.

setIndexingMode

public IndexingPolicy setIndexingMode(IndexingMode indexingMode)

Sets the indexing mode (consistent or lazy).

Parameters:

indexingMode - the indexing mode.

Returns:

the Indexing Policy.

getIncludedPaths

public List<IncludedPath> getIncludedPaths()

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

Returns:

the included paths.

setIncludedPaths

public void setIncludedPaths(List<IncludedPath> includedPaths)

getExcludedPaths

public List<ExcludedPath> getExcludedPaths()

Gets the paths that are not indexed.

Returns:

the excluded paths.

setExcludedPaths

public IndexingPolicy setExcludedPaths(List<ExcludedPath> excludedPaths)

getCompositeIndexes

public List<List<CompositePath>> getCompositeIndexes()

Gets the composite indexes for additional indexes.

Returns:

the composite indexes.

setCompositeIndexes

public IndexingPolicy setCompositeIndexes(List<List<CompositePath>> compositeIndexes)

Sets the composite indexes for additional indexes.

Parameters:

compositeIndexes - the composite indexes.

Returns:

the Indexing Policy.

getSpatialIndexes

public List<SpatialSpec> getSpatialIndexes()

Sets the spatial indexes for additional indexes.

Returns:

the spatial indexes.

setSpatialIndexes

public IndexingPolicy setSpatialIndexes(List<SpatialSpec> spatialIndexes)

Sets the spatial indexes for additional indexes.

Parameters:

spatialIndexes - the spatial indexes.

Returns:

the Indexing Policy.