Class Pipeline


  • public final class Pipeline
    extends java.lang.Object
    A pipeline is a list of Processor instances grouped under a unique id.
    • Constructor Summary

      Constructors 
      Constructor Description
      Pipeline​(java.lang.String id, java.lang.String description, java.lang.Integer version, CompoundProcessor compoundProcessor)  
    • Method Summary

      Modifier and Type Method Description
      static Pipeline create​(java.lang.String id, java.util.Map<java.lang.String,​java.lang.Object> config, java.util.Map<java.lang.String,​Processor.Factory> processorFactories, ScriptService scriptService)  
      IngestDocument execute​(IngestDocument ingestDocument)
      Modifies the data of a document to be indexed based on the processor this pipeline holds If null is returned then this document will be dropped and not indexed, otherwise this document will be kept and indexed.
      java.util.List<Processor> flattenAllProcessors()
      Flattens the normal and on failure processors into a single list.
      CompoundProcessor getCompoundProcessor()
      Get the underlying CompoundProcessor containing the Pipeline's processors
      java.lang.String getDescription()
      An optional description of what this pipeline is doing to the data gets processed by this pipeline.
      java.lang.String getId()
      The unique id of this pipeline
      org.elasticsearch.ingest.IngestMetric getMetrics()
      The metrics associated with this pipeline.
      java.util.List<Processor> getOnFailureProcessors()
      Unmodifiable list containing each on_failure processor that operates on the data in case of exception thrown in pipeline processors
      java.util.List<Processor> getProcessors()
      Unmodifiable list containing each processor that operates on the data.
      java.lang.Integer getVersion()
      An optional version stored with the pipeline so that it can be used to determine if the pipeline should be updated / replaced.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • create

        public static Pipeline create​(java.lang.String id,
                                      java.util.Map<java.lang.String,​java.lang.Object> config,
                                      java.util.Map<java.lang.String,​Processor.Factory> processorFactories,
                                      ScriptService scriptService)
                               throws java.lang.Exception
        Throws:
        java.lang.Exception
      • execute

        public IngestDocument execute​(IngestDocument ingestDocument)
                               throws java.lang.Exception
        Modifies the data of a document to be indexed based on the processor this pipeline holds If null is returned then this document will be dropped and not indexed, otherwise this document will be kept and indexed.
        Throws:
        java.lang.Exception
      • getId

        public java.lang.String getId()
        The unique id of this pipeline
      • getDescription

        @Nullable
        public java.lang.String getDescription()
        An optional description of what this pipeline is doing to the data gets processed by this pipeline.
      • getVersion

        @Nullable
        public java.lang.Integer getVersion()
        An optional version stored with the pipeline so that it can be used to determine if the pipeline should be updated / replaced.
        Returns:
        null if not supplied.
      • getProcessors

        public java.util.List<Processor> getProcessors()
        Unmodifiable list containing each processor that operates on the data.
      • getOnFailureProcessors

        public java.util.List<Processor> getOnFailureProcessors()
        Unmodifiable list containing each on_failure processor that operates on the data in case of exception thrown in pipeline processors
      • flattenAllProcessors

        public java.util.List<Processor> flattenAllProcessors()
        Flattens the normal and on failure processors into a single list. The original order is lost. This can be useful for pipeline validation purposes.
      • getMetrics

        public org.elasticsearch.ingest.IngestMetric getMetrics()
        The metrics associated with this pipeline.