Package org.opensearch.client.opensearch.core

Class ScriptsPainlessExecuteRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.ScriptsPainlessExecuteRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

@JsonpDeserializable
public class ScriptsPainlessExecuteRequest
extends RequestBase
implements PlainJsonSerializable

Allows an arbitrary script to be executed and a result to be returned

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._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 String	context()	API name: context
final PainlessContextSetup	contextSetup()	API name: context_setup
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 InlineScript	script()	API name: script
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)
ScriptsPainlessExecuteRequest.Builder	toBuilder()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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 String context()

API name: context

contextSetup

@Nullable
public final PainlessContextSetup contextSetup()

API name: context_setup

script

@Nullable
public final InlineScript script()

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)

toBuilder

public ScriptsPainlessExecuteRequest.Builder toBuilder()

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.