Package co.elastic.clients.elasticsearch.core

Class PutScriptRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.PutScriptRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutScriptRequest
extends RequestBase
implements JsonpSerializable

Creates or updates a stored script or search template.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutScriptRequest>	_DESERIALIZER	Json deserializer for PutScriptRequest
static final Endpoint<PutScriptRequest,PutScriptResponse,ErrorResponse>	_ENDPOINT	Endpoint "put_script".

Method Summary

Modifier and Type	Method	Description
final String	context()	Context in which the script or search template should run.
final String	id()	Required - Identifier for the stored script or search template.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static PutScriptRequest	of(Function<PutScriptRequest.Builder,ObjectBuilder<PutScriptRequest>> fn)
final StoredScript	script()	Required - Contains the script or search template, its parameters, and its language.
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	setupPutScriptRequestDeserializer(ObjectDeserializer<PutScriptRequest.Builder> op)
final Time	timeout()	Period to wait for a response.

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<PutScriptRequest> _DESERIALIZER

Json deserializer for PutScriptRequest

_ENDPOINT

public static final Endpoint<PutScriptRequest,PutScriptResponse,ErrorResponse> _ENDPOINT

Endpoint "put_script".

Method Details

of

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

context

@Nullable
public final String context()

Context in which the script or search template should run. To prevent errors, the API immediately compiles the script or template in this context.

API name: context

id

public final String id()

Required - Identifier for the stored script or search template. Must be unique within the cluster.

API name: id

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

script

public final StoredScript script()

Required - Contains the script or search template, its parameters, and its language.

API name: script

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

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)

setupPutScriptRequestDeserializer

protected static void setupPutScriptRequestDeserializer(ObjectDeserializer<PutScriptRequest.Builder> op)