org.elasticsearch.search.aggregations.metrics.scripted.ScriptedMetricBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch
Elasticsearch - Open Source, Distributed, RESTful Search Engine
There is a newer version: 8.16.0
/*
 * 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.search.aggregations.metrics.scripted;

import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder;

import java.io.IOException;
import java.util.Map;

/**
 * Builder for the {@link ScriptedMetric} aggregation.
 */
public class ScriptedMetricBuilder extends MetricsAggregationBuilder {

    private Map params = null;
    private Map reduceParams = null;
    private String initScript = null;
    private String mapScript = null;
    private String combineScript = null;
    private String reduceScript = null;
    private String initScriptFile = null;
    private String mapScriptFile = null;
    private String combineScriptFile = null;
    private String reduceScriptFile = null;
    private String initScriptId = null;
    private String mapScriptId = null;
    private String combineScriptId = null;
    private String reduceScriptId = null;
    private String lang = null;

    /**
     * Sole constructor.
     */
    public ScriptedMetricBuilder(String name) {
        super(name, InternalScriptedMetric.TYPE.name());
    }

    /**
     * Set parameters that will be available in the init, map
     * and combine phases.
     */
    public ScriptedMetricBuilder params(Map params) {
        this.params = params;
        return this;
    }

    /**
     * Set parameters that will be available in the reduce phase.
     */
    public ScriptedMetricBuilder reduceParams(Map reduceParams) {
        this.reduceParams = reduceParams;
        return this;
    }

    /**
     * Set the init script.
     */
    public ScriptedMetricBuilder initScript(String initScript) {
        this.initScript = initScript;
        return this;
    }

    /**
     * Set the map script.
     */
    public ScriptedMetricBuilder mapScript(String mapScript) {
        this.mapScript = mapScript;
        return this;
    }

    /**
     * Set the combine script.
     */
    public ScriptedMetricBuilder combineScript(String combineScript) {
        this.combineScript = combineScript;
        return this;
    }

    /**
     * Set the reduce script.
     */
    public ScriptedMetricBuilder reduceScript(String reduceScript) {
        this.reduceScript = reduceScript;
        return this;
    }

    /**
     * Set the init script file.
     */
    public ScriptedMetricBuilder initScriptFile(String initScriptFile) {
        this.initScriptFile = initScriptFile;
        return this;
    }

    /**
     * Set the map script file.
     */
    public ScriptedMetricBuilder mapScriptFile(String mapScriptFile) {
        this.mapScriptFile = mapScriptFile;
        return this;
    }

    /**
     * Set the combine script file.
     */
    public ScriptedMetricBuilder combineScriptFile(String combineScriptFile) {
        this.combineScriptFile = combineScriptFile;
        return this;
    }

    /**
     * Set the reduce script file.
     */
    public ScriptedMetricBuilder reduceScriptFile(String reduceScriptFile) {
        this.reduceScriptFile = reduceScriptFile;
        return this;
    }

    /**
     * Set the indexed init script id.
     */
    public ScriptedMetricBuilder initScriptId(String initScriptId) {
        this.initScriptId = initScriptId;
        return this;
    }

    /**
     * Set the indexed map script id.
     */
    public ScriptedMetricBuilder mapScriptId(String mapScriptId) {
        this.mapScriptId = mapScriptId;
        return this;
    }

    /**
     * Set the indexed combine script id.
     */
    public ScriptedMetricBuilder combineScriptId(String combineScriptId) {
        this.combineScriptId = combineScriptId;
        return this;
    }

    /**
     * Set the indexed reduce script id.
     */
    public ScriptedMetricBuilder reduceScriptId(String reduceScriptId) {
        this.reduceScriptId = reduceScriptId;
        return this;
    }

    /**
     * Set the script language.
     */
    public ScriptedMetricBuilder lang(String lang) {
        this.lang = lang;
        return this;
    }

    @Override
    protected void internalXContent(XContentBuilder builder, Params builderParams) throws IOException {
        if (params != null) {
            builder.field(ScriptedMetricParser.PARAMS_FIELD.getPreferredName());
            builder.map(params);
        }
        
        if (reduceParams != null) {
            builder.field(ScriptedMetricParser.REDUCE_PARAMS_FIELD.getPreferredName());
            builder.map(reduceParams);
        }
        
        if (initScript != null) {
            builder.field(ScriptedMetricParser.INIT_SCRIPT_FIELD.getPreferredName(), initScript);
        }
        
        if (mapScript != null) {
            builder.field(ScriptedMetricParser.MAP_SCRIPT_FIELD.getPreferredName(), mapScript);
        }
        
        if (combineScript != null) {
            builder.field(ScriptedMetricParser.COMBINE_SCRIPT_FIELD.getPreferredName(), combineScript);
        }
        
        if (reduceScript != null) {
            builder.field(ScriptedMetricParser.REDUCE_SCRIPT_FIELD.getPreferredName(), reduceScript);
        }
        
        if (initScriptFile != null) {
            builder.field(ScriptedMetricParser.INIT_SCRIPT_FILE_FIELD.getPreferredName(), initScriptFile);
        }
        
        if (mapScriptFile != null) {
            builder.field(ScriptedMetricParser.MAP_SCRIPT_FILE_FIELD.getPreferredName(), mapScriptFile);
        }
        
        if (combineScriptFile != null) {
            builder.field(ScriptedMetricParser.COMBINE_SCRIPT_FILE_FIELD.getPreferredName(), combineScriptFile);
        }
        
        if (reduceScriptFile != null) {
            builder.field(ScriptedMetricParser.REDUCE_SCRIPT_FILE_FIELD.getPreferredName(), reduceScriptFile);
        }
        
        if (initScriptId != null) {
            builder.field(ScriptedMetricParser.INIT_SCRIPT_ID_FIELD.getPreferredName(), initScriptId);
        }
        
        if (mapScriptId != null) {
            builder.field(ScriptedMetricParser.MAP_SCRIPT_ID_FIELD.getPreferredName(), mapScriptId);
        }
        
        if (combineScriptId != null) {
            builder.field(ScriptedMetricParser.COMBINE_SCRIPT_ID_FIELD.getPreferredName(), combineScriptId);
        }
        
        if (reduceScriptId != null) {
            builder.field(ScriptedMetricParser.REDUCE_SCRIPT_ID_FIELD.getPreferredName(), reduceScriptId);
        }
        
        if (lang != null) {
            builder.field(ScriptedMetricParser.LANG_FIELD.getPreferredName(), lang);
        }
    }

}