org.graylog2.indexer.indices.IndicesAdapter Maven / Gradle / Ivy

Go to download
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.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.indexer.indices;

import com.fasterxml.jackson.databind.JsonNode;
import com.github.joschi.jadconfig.util.Duration;
import org.graylog2.indexer.indices.blocks.IndicesBlockStatus;
import org.graylog2.indexer.indices.stats.IndexStatistics;
import org.graylog2.indexer.searches.IndexRangeStats;
import org.joda.time.DateTime;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;

public interface IndicesAdapter {
    void move(String source, String target, Consumer resultCallback);

    void delete(String indexName);

    Set resolveAlias(String alias);

    void create(String indexName, IndexSettings indexSettings);

    /**
     * Add fields to an existing index or to change search only settings of existing fields
     * @param indexName existing index name
     * @param mappingType target mapping type (e.g. message). Not relevant for ES7+ (will be simply ignored).
     * @param mapping field mappings
     */
    void updateIndexMapping(@Nonnull String indexName, @Nonnull String mappingType, @Nonnull Map mapping);

    /**
     * Updates the metadata field (_meta) of an index mapping
     * @param indexName existing index name
     * @param metaData  the new metadata
     * @param mergeExisting merge or overwrite existing metadata
     */
    void updateIndexMetaData(@Nonnull String indexName, @Nonnull Map metaData, boolean mergeExisting);
    Map getIndexMetaData(@Nonnull String indexName);

    boolean ensureIndexTemplate(String templateName, Template template);

    boolean indexTemplateExists(String templateName);

    Optional indexCreationDate(String index);

    Optional indexClosingDate(String index);

    void openIndex(String index);

    void setReadOnly(String index);

    void flush(String index);

    void markIndexReopened(String index);

    void removeAlias(String indexName, String alias);

    void close(String indexName);

    long numberOfMessages(String indexName);

    boolean aliasExists(String alias) throws IOException;

    Map> aliases(String indexPattern);

    boolean deleteIndexTemplate(String templateName);

    Map> fieldsInIndices(String[] writeIndexWildcards);

    Set closedIndices(Collection indices);

    Set indicesStats(Collection indices);

    Optional getIndexStats(String index);

    JsonNode getIndexStats(Collection index);

    IndicesBlockStatus getIndicesBlocksStatus(List indices);

    boolean exists(String indexName) throws IOException;

    Set indices(String indexWildcard, List status, String id);

    Optional storeSizeInBytes(String index);

    void cycleAlias(String aliasName, String targetIndex);

    void cycleAlias(String aliasName, String targetIndex, String oldIndex);

    void removeAliases(Set indices, String alias);

    void optimizeIndex(String index, int maxNumSegments, Duration timeout);

    IndexRangeStats indexRangeStatsOfIndex(String index);

    HealthStatus waitForRecovery(String index);
    HealthStatus waitForRecovery(String index, int timeout);

    boolean isOpen(String index);

    boolean isClosed(String index);

    String getIndexId(String index);

    void refresh(String... indices);
}