Package org.springframework.data.elasticsearch.annotations

Annotation Interface Alias

@Inherited @Retention(RUNTIME) @Target(TYPE) @Repeatable(Aliases.class) public @interface Alias
Identifies an alias for the index.
Since:
5.4
Author:
Youssef Aouichaoui

  • Element Details

    • value

      @AliasFor("alias") String value
      Returns:
      Index alias name. Alias for alias().
      Default:
      ""

    • alias

      @AliasFor("value") String alias
      Returns:
      Index alias name. Alias for value().
      Default:
      ""

    • filter

      Filter filter
      Returns:
      Query used to limit documents the alias can access.
      Default:
      @org.springframework.data.elasticsearch.annotations.Filter

    • indexRouting

      String indexRouting
      Returns:
      Used to route indexing operations to a specific shard.
      Default:
      ""

    • routing

      String routing
      Returns:
      Used to route indexing and search operations to a specific shard.
      Default:
      ""

    • searchRouting

      String searchRouting
      Returns:
      Used to route search operations to a specific shard.
      Default:
      ""

    • isHidden

      boolean isHidden
      Returns:
      Is the alias hidden?
      Default:
      false

    • isWriteIndex

      boolean isWriteIndex
      Returns:
      Is it the 'write index' for the alias?
      Default:
      false