Package org.elasticsearch.ingest

Interface Processor

All Known Subinterfaces:

WrappingProcessor

All Known Implementing Classes:

AbstractProcessor, CompoundProcessor, ConditionalProcessor, DropProcessor, PipelineProcessor, TrackingResultProcessor

public interface Processor

A processor implementation may modify the data belonging to a document. Whether changes are made and what exactly is modified is up to the implementation. Processors may get called concurrently and thus need to be thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Processor.Factory	A factory that knows how to construct a processor based on a map of maps.
static class	Processor.Parameters	Infrastructure class that holds services that can be used by processor factories to create processor instances and that gets passed around to all IngestPlugins.

Method Summary

Modifier and Type	Method	Description
IngestDocument	execute(IngestDocument ingestDocument)	Introspect and potentially modify the incoming data.
default void	execute(IngestDocument ingestDocument, BiConsumer<IngestDocument,Exception> handler)	Introspect and potentially modify the incoming data.
String	getDescription()	Gets the description of a processor.
String	getTag()	Gets the tag of a processor.
String	getType()	Gets the type of a processor

Method Details

execute

default void execute(IngestDocument ingestDocument,
 BiConsumer<IngestDocument,Exception> handler)

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 execute(IngestDocument).

execute

IngestDocument execute(IngestDocument ingestDocument)
                throws Exception

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:

Exception

getType

String getType()

Gets the type of a processor

getTag

String getTag()

Gets the tag of a processor.

getDescription

String getDescription()

Gets the description of a processor.