org.elasticsearch.script.UpdateScript Maven / Gradle / Ivy

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

Elasticsearch subproject :distribution:archives:integ-test-zip

There is a newer version: 8.14.0


/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.script;

import org.elasticsearch.common.logging.DeprecationCategory;
import org.elasticsearch.common.logging.DeprecationLogger;

import java.util.Map;
import java.util.function.Function;

/**
 * An update script.
 */
public abstract class UpdateScript {

    private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(DynamicMap.class);
    private static final Map> PARAMS_FUNCTIONS = org.elasticsearch.core.Map.of("_type", value -> {
        deprecationLogger.critical(
            DeprecationCategory.SCRIPTING,
            "update-script",
            "[types removal] Looking up doc types [_type] in scripts is deprecated."
        );
        return value;
    });

    public static final String[] PARAMETERS = {};

    /** The context used to compile {@link UpdateScript} factories. */
    public static final ScriptContext CONTEXT = new ScriptContext<>("update", Factory.class);

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

    /** The update context for the script. */
    private final Map ctx;

    public UpdateScript(Map params, Map ctx) {
        this.params = params;
        this.ctx = new DynamicMap(ctx, PARAMS_FUNCTIONS);
    }

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

    /** Return the update context for this script. */
    public Map getCtx() {
        return ctx;
    }

    public abstract void execute();

    public interface Factory {
        UpdateScript newInstance(Map params, Map ctx);
    }
}