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, ToCopyableBuilder<ScriptsPainlessExecuteRequest.Builder,ScriptsPainlessExecuteRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class ScriptsPainlessExecuteRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<ScriptsPainlessExecuteRequest.Builder,ScriptsPainlessExecuteRequest>

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
static ScriptsPainlessExecuteRequest.Builder	builder()
final String	context()	The context that the script should run in.
final PainlessContextSetup	contextSetup()	API name: context_setup
static <TResult> Endpoint<ScriptsPainlessExecuteRequest,ScriptsPainlessExecuteResponse<TResult>,ErrorResponse>	createScriptsPainlessExecuteEndpoint(JsonpDeserializer<TResult> tResultDeserializer)	Create an "scripts_painless_execute" endpoint.
boolean	equals(Object o)
int	hashCode()
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()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

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

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

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

The context that the script should run in.

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

@Nonnull
public ScriptsPainlessExecuteRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScriptsPainlessExecuteRequest.Builder,ScriptsPainlessExecuteRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static ScriptsPainlessExecuteRequest.Builder builder()

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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object