org.elasticsearch.script.BucketAggregationSelectorScript 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.2

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.script;

import java.util.Map;

/**
 * A script used in bucket aggregations that returns a {@code boolean} value.
 */
public abstract class BucketAggregationSelectorScript {

    public static final String[] PARAMETERS = {};

    public static final ScriptContext CONTEXT = new ScriptContext<>("aggregation_selector", Factory.class);

    /**
     * The generic runtime parameters for the script.
     */
    private final Map params;

    public BucketAggregationSelectorScript(Map params) {
        this.params = params;
    }

    /**
     * Return the parameters for this script.
     */
    public Map getParams() {
        return params;
    }

    public abstract boolean execute();

    public interface Factory {
        BucketAggregationSelectorScript newInstance(Map params);
    }
}