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

Annotation Type CosmosIndexingPolicy

@Inherited @Retention(RUNTIME) @Target(TYPE) public @interface CosmosIndexingPolicy
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.

  • Element Details

    • overwritePolicy

      boolean overwritePolicy
      Whether or not to overwrite the indexing policy specified in the Portal.
      Returns:
      default as false
      Default:
      false

    • automatic

      boolean automatic
      To set automatic indexing
      Returns:
      default as true
      Default:
      true

    • mode

      IndexingMode mode
      To set indexing mode
      Returns:
      IndexingMode
      Default:
      CONSISTENT

    • includePaths

      String[] includePaths
      To include paths
      Returns:
      String[]
      Default:
      {}

    • excludePaths

      String[] excludePaths
      To exclude paths
      Returns:
      String[]
      Default:
      {}

    • compositeIndexes

      CompositeIndex[] compositeIndexes
      Composite Indexes
      Returns:
      CompositeIndexDefinition[]
      Default:
      {}