com.azure.cosmos.models

Class IndexingPolicy

java.lang.Object

com.azure.cosmos.models.IndexingPolicy

public final class IndexingPolicy
extends Object

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

Constructor Summary

Constructors

Constructor and Description
IndexingPolicy() Constructor.

Method Summary

Modifier and Type	Method and Description
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.
Boolean	isAutomatic() Gets whether automatic indexing is enabled for a container.
IndexingPolicy	setAutomatic(boolean automatic) Sets whether automatic indexing is enabled for a container.
IndexingPolicy	setCompositeIndexes(List<List<CompositePath>> compositeIndexes) Sets the composite indexes for additional indexes.
IndexingPolicy	setExcludedPaths(List<ExcludedPath> excludedPaths) Sets excluded paths.
IndexingPolicy	setIncludedPaths(List<IncludedPath> includedPaths) Sets included paths.
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 java.lang.Object

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

Constructor Detail

IndexingPolicy

public IndexingPolicy()

Constructor.

Method Detail

isAutomatic

public Boolean isAutomatic()

Gets whether automatic indexing is enabled for a container.

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

Returns:

the automatic

setAutomatic

public IndexingPolicy setAutomatic(boolean automatic)

Sets whether automatic indexing is enabled for a container.

In automatic indexing, items can be explicitly excluded from indexing using RequestOptions. In manual indexing, items 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 IndexingPolicy setIncludedPaths(List<IncludedPath> includedPaths)

Sets included paths.

Parameters:

includedPaths - the included paths

Returns:

the included paths

getExcludedPaths

public List<ExcludedPath> getExcludedPaths()

Gets the paths that are not indexed.

Returns:

the excluded paths.

setExcludedPaths

public IndexingPolicy setExcludedPaths(List<ExcludedPath> excludedPaths)

Sets excluded paths.

Parameters:

excludedPaths - the excluded paths

Returns:

the excluded paths

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.