通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosIndexingPolicy Interface

  • Reference
Package:
com.azure.spring.data.cosmos.core.mapping
Maven Artifact:
com.azure:azure-spring-data-cosmos:5.19.0

Implements

Annotation

public interface CosmosIndexingPolicy
implements Annotation

Annotation for cosmos indexing policy. Using this annotation will NOT overwrite the cosmos indexing policy currently in Azure Portal by default. See `overwritePolicy()` for more details. To prevent overwriting the Indexing Policy defined on Azure Portal, Indexing Policy defined on the SDK through this annotation should be identical or set overwritePolicy flag to false.

Method Summary

Modifier and Type Method and Description
abstract boolean automatic()

To set automatic indexing
abstract CompositeIndex[] compositeIndexes()

Composite Indexes
abstract String[] excludePaths()

To exclude paths
abstract String[] includePaths()

To include paths
abstract IndexingMode mode()

To set indexing mode
abstract boolean overwritePolicy()

Whether or not to overwrite the indexing policy specified in the Portal.

Method Details

automatic

public abstract boolean automatic()

To set automatic indexing

Returns:

default as true

compositeIndexes

public abstract CompositeIndex[] compositeIndexes()

Composite Indexes

Returns:

CompositeIndexDefinition[]

excludePaths

public abstract String[] excludePaths()

To exclude paths

Returns:

String[]

includePaths

public abstract String[] includePaths()

To include paths

Returns:

String[]

mode

public abstract IndexingMode mode()

To set indexing mode

Returns:

IndexingMode

overwritePolicy

public abstract boolean overwritePolicy()

Whether or not to overwrite the indexing policy specified in the Portal.

Returns:

default as false

Applies to