com.yahoo.config.model.api.Reindexing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-model-api Show documentation

There is a newer version: 8.441.21

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.model.api;

import java.time.Instant;
import java.util.Optional;

/**
 * Status of reindexing for the documents of an application.
 *
 * @author jonmv
 */
public interface Reindexing {

    /** Reindexing status for this application, for a given cluster and document type. */
    default Optional status(String cluster, String documentType) { return Optional.empty(); }

    /** Returns whether reindexing should run for this application. */
    default boolean enabled() { return false; }

    /** Reindexing status of a given document type in a given cluster in a given application. */
    interface Status {

        /** The instant at which reindexing may begin. */
        Instant ready();

        /** The relative speed with which to reindex. */
        double speed();

        /** The cause of reindexing for this document type. */
        String cause();

    }

    Reindexing DISABLED_INSTANCE = new Reindexing() {};

}