org.elasticsearch.indices.IndexPatternMatcher Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.13.4

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.indices;

import org.elasticsearch.cluster.metadata.Metadata;

import java.util.List;

/**
 * An IndexPatternMatcher holds an index pattern in a string and, given a
 * {@link Metadata} object, can return a list of index names matching that pattern.
 */
public interface IndexPatternMatcher {
    /**
     * @return A pattern, either with a wildcard or simple regex, describing indices that are
     * related to a system feature. Such indices may be system indices or associated
     * indices.
     */
    String getIndexPattern();

    /**
     * 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 {@link org.elasticsearch.cluster.metadata.IndexNameExpressionResolver} because that class can only handle
     * simple wildcard expressions, but system index name patterns may use full Lucene regular expression syntax,
     *
     * @param metadata The current metadata to get the list of matching indices from
     * @return A list of index names that match this descriptor
     */
    List getMatchingIndices(Metadata metadata);
}