Package org.elasticsearch.ingest

Class PipelineProcessor

java.lang.Object
org.elasticsearch.ingest.AbstractProcessor
org.elasticsearch.ingest.PipelineProcessor
All Implemented Interfaces:
Processor
public class PipelineProcessor
extends AbstractProcessor

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  PipelineProcessor.Factory  

    Nested classes/interfaces inherited from interface org.elasticsearch.ingest.Processor

    Processor.Parameters

  • Field Summary

    Fields
    Modifier and Type Field Description
    static java.lang.String TYPE  

    Fields inherited from class org.elasticsearch.ingest.AbstractProcessor

    description, tag

  • Method Summary

    Modifier and Type Method Description
    IngestDocument execute​(IngestDocument ingestDocument)
    Introspect and potentially modify the incoming data.
    void execute​(IngestDocument ingestDocument, java.util.function.BiConsumer<IngestDocument,​java.lang.Exception> handler)
    Introspect and potentially modify the incoming data.
    java.lang.String getType()
    Gets the type of a processor

    Methods inherited from class org.elasticsearch.ingest.AbstractProcessor

    getDescription, getTag

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • execute

      public void execute​(IngestDocument ingestDocument, java.util.function.BiConsumer<IngestDocument,​java.lang.Exception> handler)
      Description copied from interface: Processor
      Introspect and potentially modify the incoming data. Expert method: only override this method if a processor implementation needs to make an asynchronous call, otherwise just overwrite Processor.execute(IngestDocument).

    • execute

      public IngestDocument execute​(IngestDocument ingestDocument) throws java.lang.Exception
      Description copied from interface: Processor
      Introspect and potentially modify the incoming data.
      Returns:
      If null is returned then the current document will be dropped and not be indexed, otherwise this document will be kept and indexed
      Throws:
      java.lang.Exception

    • getType

      public java.lang.String getType()
      Description copied from interface: Processor
      Gets the type of a processor