com.azure.spring.data.cosmos.core.mapping

Annotation Type CosmosIndexingPolicy

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface CosmosIndexingPolicy

Annotation for cosmos indexing policy

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	automatic To set automatic indexing
CompositeIndex[]	compositeIndexes Composite Indexes
String[]	excludePaths To exclude paths
String[]	includePaths To include paths
IndexingMode	mode To set indexing mode

Element Detail

automatic

public abstract boolean automatic

To set automatic indexing

Returns:

default as true

Default:

true

mode

public abstract IndexingMode mode

To set indexing mode

Returns:

IndexingMode

Default:

com.azure.cosmos.models.IndexingMode.CONSISTENT

includePaths

public abstract String[] includePaths

To include paths

Returns:

String[]

Default:

{}

excludePaths

public abstract String[] excludePaths

To exclude paths

Returns:

String[]

Default:

{}

compositeIndexes

public abstract CompositeIndex[] compositeIndexes

Composite Indexes

Returns:

CompositeIndexDefinition[]

Default:

{}