org.opensearch.search.backpressure.settings.SearchBackpressureMode Maven / Gradle / Ivy

Go to download

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

OpenSearch subproject :server

There is a newer version: 2.18.0

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.search.backpressure.settings;

import java.util.Locale;

/**
 * Defines the search backpressure mode.
 */
public enum SearchBackpressureMode {
    /**
     * SearchBackpressureService is completely disabled.
     */
    DISABLED("disabled"),

    /**
     * SearchBackpressureService only monitors the resource usage of running tasks.
     */
    MONITOR_ONLY("monitor_only"),

    /**
     * SearchBackpressureService monitors and rejects tasks that exceed resource usage thresholds.
     */
    ENFORCED("enforced");

    private final String name;

    SearchBackpressureMode(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    public static SearchBackpressureMode fromName(String name) {
        switch (name.toLowerCase(Locale.ROOT)) {
            case "disabled":
                return DISABLED;
            case "monitor_only":
                return MONITOR_ONLY;
            case "enforced":
                return ENFORCED;
        }

        throw new IllegalArgumentException("Invalid SearchBackpressureMode: " + name);
    }
}