Package com.microsoft.azure.management.cosmosdb

Class IndexingPolicy

java.lang.Object

com.microsoft.azure.management.cosmosdb.IndexingPolicy

public class IndexingPolicy
extends Object

Cosmos DB indexing policy.

Constructor Summary

Constructors

Constructor	Description
IndexingPolicy()

Method Summary

Modifier and Type	Method	Description
Boolean	automatic()	Get indicates if the indexing policy is automatic.
List<ExcludedPath>	excludedPaths()	Get list of paths to exclude from indexing.
List<IncludedPath>	includedPaths()	Get list of paths to include in the indexing.
IndexingMode	indexingMode()	Get indicates the indexing mode.
IndexingPolicy	withAutomatic(Boolean automatic)	Set indicates if the indexing policy is automatic.
IndexingPolicy	withExcludedPaths(List<ExcludedPath> excludedPaths)	Set list of paths to exclude from indexing.
IndexingPolicy	withIncludedPaths(List<IncludedPath> includedPaths)	Set list of paths to include in the indexing.
IndexingPolicy	withIndexingMode(IndexingMode indexingMode)	Set indicates the indexing mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexingPolicy

public IndexingPolicy()

Method Detail

automatic

public Boolean automatic()

Get indicates if the indexing policy is automatic.

Returns:

the automatic value

withAutomatic

public IndexingPolicy withAutomatic(Boolean automatic)

Set indicates if the indexing policy is automatic.

Parameters:

automatic - the automatic value to set

Returns:

the IndexingPolicy object itself.

indexingMode

public IndexingMode indexingMode()

Get indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'.

Returns:

the indexingMode value

withIndexingMode

public IndexingPolicy withIndexingMode(IndexingMode indexingMode)

Set indicates the indexing mode. Possible values include: 'Consistent', 'Lazy', 'None'.

Parameters:

indexingMode - the indexingMode value to set

Returns:

the IndexingPolicy object itself.

includedPaths

public List<IncludedPath> includedPaths()

Get list of paths to include in the indexing.

Returns:

the includedPaths value

withIncludedPaths

public IndexingPolicy withIncludedPaths(List<IncludedPath> includedPaths)

Set list of paths to include in the indexing.

Parameters:

includedPaths - the includedPaths value to set

Returns:

the IndexingPolicy object itself.

excludedPaths

public List<ExcludedPath> excludedPaths()

Get list of paths to exclude from indexing.

Returns:

the excludedPaths value

withExcludedPaths

public IndexingPolicy withExcludedPaths(List<ExcludedPath> excludedPaths)

Set list of paths to exclude from indexing.

Parameters:

excludedPaths - the excludedPaths value to set

Returns:

the IndexingPolicy object itself.