Package co.elastic.clients.elasticsearch.ingest

Class PutPipelineRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ingest.PutPipelineRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutPipelineRequest extends RequestBase implements JsonpSerializable
Create or update a pipeline. Changes made using this API take effect immediately.
See Also:

  • Field Details

  • Method Details

    • of

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

    • meta

      public final Map<String,JsonData> meta()
      Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.

      API name: _meta

    • deprecated

      @Nullable public final Boolean deprecated()
      Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.

      API name: deprecated

    • description

      @Nullable public final String description()
      Description of the ingest pipeline.

      API name: description

    • fieldAccessPattern

      @Nullable public final FieldAccessPattern fieldAccessPattern()
      Controls how processors in this pipeline should read and write data on a document's source.

      API name: field_access_pattern

    • id

      public final String id()
      Required - ID of the ingest pipeline to create or update.

      API name: id

    • ifVersion

      @Nullable public final Long ifVersion()
      Required version for optimistic concurrency control for pipeline updates

      API name: if_version

    • 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

    • onFailure

      public final List<Processor> onFailure()
      Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.

      API name: on_failure

    • processors

      public final List<Processor> processors()
      Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

      API name: processors

    • 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

    • version

      @Nullable public final Long version()
      Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.

      API name: version

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

    • setupPutPipelineRequestDeserializer

      protected static void setupPutPipelineRequestDeserializer(ObjectDeserializer<PutPipelineRequest.Builder> op)