Package co.elastic.clients.elasticsearch.ingest

Class Pipeline

java.lang.Object
co.elastic.clients.elasticsearch.ingest.Pipeline
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Pipeline extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • description

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

      API name: description

    • onFailure

      public final List<Processor> onFailure()
      Processors to run immediately after a processor failure.

      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

    • version

      @Nullable public final Long version()
      Version number used by external systems to track ingest pipelines.

      API name: version

    • 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

    • meta

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

      API name: _meta

    • createdDate

      @Nullable public final DateTime createdDate()
      Date and time when the pipeline was created. Only returned if the human query parameter is true.

      API name: created_date

    • createdDateMillis

      @Nullable public final Long createdDateMillis()
      Date and time when the pipeline was created, in milliseconds since the epoch.

      API name: created_date_millis

    • modifiedDate

      @Nullable public final DateTime modifiedDate()
      Date and time when the pipeline was last modified. Only returned if the human query parameter is true.

      API name: modified_date

    • modifiedDateMillis

      @Nullable public final Long modifiedDateMillis()
      Date and time when the pipeline was last modified, in milliseconds since the epoch.

      API name: modified_date_millis

    • 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

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupPipelineDeserializer

      protected static void setupPipelineDeserializer(ObjectDeserializer<Pipeline.Builder> op)