Package co.elastic.clients.elasticsearch.core

Class ScriptsPainlessExecuteRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.ScriptsPainlessExecuteRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ScriptsPainlessExecuteRequest
extends RequestBase
implements JsonpSerializable

Run a script.

Runs a script and returns a result. Use this API to build and test scripts, such as when defining a script for a runtime field. This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster.

The API uses several contexts, which control how scripts are run, what variables are available at runtime, and what the return type is.

Each context requires a script, but additional parameters depend on the context you're using for that script.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptsPainlessExecuteRequest.Builder	Builder for ScriptsPainlessExecuteRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ScriptsPainlessExecuteRequest>	_DESERIALIZER	Json deserializer for ScriptsPainlessExecuteRequest
static final SimpleEndpoint<ScriptsPainlessExecuteRequest,?>	_ENDPOINT	Endpoint "scripts_painless_execute".

Method Summary

Modifier and Type	Method	Description
final PainlessContext	context()	The context that the script should run in.
final PainlessContextSetup	contextSetup()	Additional parameters for the context.
static <TResult> Endpoint<ScriptsPainlessExecuteRequest,ScriptsPainlessExecuteResponse<TResult>,ErrorResponse>	createScriptsPainlessExecuteEndpoint(JsonpDeserializer<TResult> tResultDeserializer)	Create an "scripts_painless_execute" endpoint.
static ScriptsPainlessExecuteRequest	of(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn)
final Script	script()	The Painless script to run.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupScriptsPainlessExecuteRequestDeserializer(ObjectDeserializer<ScriptsPainlessExecuteRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ScriptsPainlessExecuteRequest> _DESERIALIZER

Json deserializer for ScriptsPainlessExecuteRequest

_ENDPOINT

public static final SimpleEndpoint<ScriptsPainlessExecuteRequest,?> _ENDPOINT

Endpoint "scripts_painless_execute".

Method Details

of

public static ScriptsPainlessExecuteRequest of(Function<ScriptsPainlessExecuteRequest.Builder,ObjectBuilder<ScriptsPainlessExecuteRequest>> fn)

context

@Nullable
public final PainlessContext context()

The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed.

API name: context

contextSetup

@Nullable
public final PainlessContextSetup contextSetup()

Additional parameters for the context. NOTE: This parameter is required for all contexts except painless_test, which is the default if no value is provided for context.

API name: context_setup

script

@Nullable
public final Script script()

The Painless script to run.

API name: script

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupScriptsPainlessExecuteRequestDeserializer

protected static void setupScriptsPainlessExecuteRequestDeserializer(ObjectDeserializer<ScriptsPainlessExecuteRequest.Builder> op)

createScriptsPainlessExecuteEndpoint

public static <TResult>
Endpoint<ScriptsPainlessExecuteRequest,ScriptsPainlessExecuteResponse<TResult>,ErrorResponse> createScriptsPainlessExecuteEndpoint(JsonpDeserializer<TResult> tResultDeserializer)

Create an "scripts_painless_execute" endpoint.