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
Create or update a script or search template. Creates or updates a stored script or search template.
See Also:

  • Field Details

  • Method Details

    • of

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

    • context

      @Nullable public final String context()
      The 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 - The identifier for the stored script or search template. It must be unique within the cluster.

      API name: id

    • masterTimeout

      @Nullable public final Time masterTimeout()
      The 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. It can also be set to -1 to indicate that the request should never timeout.

      API name: master_timeout

    • script

      public final StoredScript script()
      Required - The script or search template, its parameters, and its language.

      API name: script

    • timeout

      @Nullable public final Time timeout()
      The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

      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)