org.graylog2.indexer.IndexMappingTemplate Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation

Graylog

There is a newer version: 6.0.6

/**
 * This file is part of Graylog.
 *
 * Graylog is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Graylog.  If not, see .
 */
package org.graylog2.indexer;

import org.graylog2.indexer.indexset.IndexSetConfig;

import java.util.Map;

/**
 * Implementing classes provide an index mapping template representation that can be stored in Elasticsearch.
 */
public interface IndexMappingTemplate {
    /**
     * Returns the index template as a map.
     *
     * @param indexSetConfig the index set configuration
     * @param indexPattern   the index pattern the returned template should be applied to
     * @param order          the order value of the index template
     * @return the index template
     */
    Map toTemplate(IndexSetConfig indexSetConfig, String indexPattern, int order);

    /**
     * Returns the index template as a map. (with an default order of -1)
     *
     * @param indexSetConfig the index set configuration
     * @param indexPattern   the index pattern the returned template should be applied to
     * @return the index template
     */
    default Map toTemplate(IndexSetConfig indexSetConfig, String indexPattern) {
        return toTemplate(indexSetConfig, indexPattern, -1);
    }
}