Module org.elasticsearch.server
Package org.elasticsearch.indices

Interface IndexMatcher

All Known Subinterfaces:
IndexPatternMatcher, SystemResourceDescriptor
All Known Implementing Classes:
AssociatedIndexDescriptor, SystemDataStreamDescriptor, SystemIndexDescriptor
public interface IndexMatcher
An IndexMatcher given a Metadata object, can return a list of index names matching that pattern.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getMatchingIndices(Metadata metadata)
    Retrieves a list of all indices which match this descriptor's pattern.

  • Method Details

    • getMatchingIndices

      List<String> getMatchingIndices(Metadata metadata)
      Retrieves a list of all indices which match this descriptor's pattern. Implementations may include other special information when matching indices, such as aliases.

      This cannot be done via IndexNameExpressionResolver because that class can only handle simple wildcard expressions, but system index name patterns may use full Lucene regular expression syntax.

      Parameters:
      metadata - The current metadata to get the list of matching indices from
      Returns:
      A list of index names that match this descriptor