com.azure.resourcemanager.cosmos.models

Class IndexingPolicy

java.lang.Object

com.azure.resourcemanager.cosmos.models.IndexingPolicy

public final class IndexingPolicy
extends Object

Cosmos DB indexing policy.

Constructor Summary

Constructors

Constructor and Description
IndexingPolicy()

Method Summary

Modifier and Type	Method and Description
Boolean	automatic() Get the automatic property: Indicates if the indexing policy is automatic.
List<List<CompositePath>>	compositeIndexes() Get the compositeIndexes property: List of composite path list.
List<ExcludedPath>	excludedPaths() Get the excludedPaths property: List of paths to exclude from indexing.
List<IncludedPath>	includedPaths() Get the includedPaths property: List of paths to include in the indexing.
IndexingMode	indexingMode() Get the indexingMode property: Indicates the indexing mode.
List<SpatialSpec>	spatialIndexes() Get the spatialIndexes property: List of spatial specifics.
void	validate() Validates the instance.
IndexingPolicy	withAutomatic(Boolean automatic) Set the automatic property: Indicates if the indexing policy is automatic.
IndexingPolicy	withCompositeIndexes(List<List<CompositePath>> compositeIndexes) Set the compositeIndexes property: List of composite path list.
IndexingPolicy	withExcludedPaths(List<ExcludedPath> excludedPaths) Set the excludedPaths property: List of paths to exclude from indexing.
IndexingPolicy	withIncludedPaths(List<IncludedPath> includedPaths) Set the includedPaths property: List of paths to include in the indexing.
IndexingPolicy	withIndexingMode(IndexingMode indexingMode) Set the indexingMode property: Indicates the indexing mode.
IndexingPolicy	withSpatialIndexes(List<SpatialSpec> spatialIndexes) Set the spatialIndexes property: List of spatial specifics.

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 the automatic property: Indicates if the indexing policy is automatic.

Returns:

the automatic value.

withAutomatic

public IndexingPolicy withAutomatic(Boolean automatic)

Set the automatic property: Indicates if the indexing policy is automatic.

Parameters:

automatic - the automatic value to set.

Returns:

the IndexingPolicy object itself.

indexingMode

public IndexingMode indexingMode()

Get the indexingMode property: Indicates the indexing mode.

Returns:

the indexingMode value.

withIndexingMode

public IndexingPolicy withIndexingMode(IndexingMode indexingMode)

Set the indexingMode property: Indicates the indexing mode.

Parameters:

indexingMode - the indexingMode value to set.

Returns:

the IndexingPolicy object itself.

includedPaths

public List<IncludedPath> includedPaths()

Get the includedPaths property: List of paths to include in the indexing.

Returns:

the includedPaths value.

withIncludedPaths

public IndexingPolicy withIncludedPaths(List<IncludedPath> includedPaths)

Set the includedPaths property: 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 the excludedPaths property: List of paths to exclude from indexing.

Returns:

the excludedPaths value.

withExcludedPaths

public IndexingPolicy withExcludedPaths(List<ExcludedPath> excludedPaths)

Set the excludedPaths property: List of paths to exclude from indexing.

Parameters:

excludedPaths - the excludedPaths value to set.

Returns:

the IndexingPolicy object itself.

compositeIndexes

public List<List<CompositePath>> compositeIndexes()

Get the compositeIndexes property: List of composite path list.

Returns:

the compositeIndexes value.

withCompositeIndexes

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

Set the compositeIndexes property: List of composite path list.

Parameters:

compositeIndexes - the compositeIndexes value to set.

Returns:

the IndexingPolicy object itself.

spatialIndexes

public List<SpatialSpec> spatialIndexes()

Get the spatialIndexes property: List of spatial specifics.

Returns:

the spatialIndexes value.

withSpatialIndexes

public IndexingPolicy withSpatialIndexes(List<SpatialSpec> spatialIndexes)

Set the spatialIndexes property: List of spatial specifics.

Parameters:

spatialIndexes - the spatialIndexes value to set.

Returns:

the IndexingPolicy object itself.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.