Module org.elasticsearch.server

Package org.elasticsearch.ingest

Class CompoundProcessor

java.lang.Object

org.elasticsearch.ingest.CompoundProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

OnFailureProcessor

public class CompoundProcessor
extends Object
implements Processor

A Processor that executes a list of other "processors". It executes a separate list of "onFailureProcessors" when any of the processors throw an Exception.

Nested Class Summary

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

Processor.Factory, Processor.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ON_FAILURE_MESSAGE_FIELD
static final String	ON_FAILURE_PIPELINE_FIELD
static final String	ON_FAILURE_PROCESSOR_TAG_FIELD
static final String	ON_FAILURE_PROCESSOR_TYPE_FIELD
static final String	PIPELINE_ORIGIN_EXCEPTION_HEADER
static final String	PROCESSOR_TAG_EXCEPTION_HEADER
static final String	PROCESSOR_TYPE_EXCEPTION_HEADER

Constructor Summary

Constructors

Constructor	Description
CompoundProcessor(boolean ignoreFailure, List<Processor> processors, List<Processor> onFailureProcessors)
CompoundProcessor(Processor... processors)

Method Summary

Modifier and Type	Method	Description
IngestDocument	execute(IngestDocument document)	Introspect and potentially modify the incoming data.
void	execute(IngestDocument ingestDocument, BiConsumer<IngestDocument,Exception> handler)	Introspect and potentially modify the incoming data.
List<Processor>	flattenProcessors()
String	getDescription()	Gets the description of a processor.
List<Processor>	getOnFailureProcessors()
List<Processor>	getProcessors()
String	getTag()	Gets the tag of a processor.
String	getType()	Gets the type of a processor
boolean	isAsync()
boolean	isIgnoreFailure()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.ingest.Processor

extraValidation

Field Details

ON_FAILURE_MESSAGE_FIELD

public static final String ON_FAILURE_MESSAGE_FIELD

See Also:

• Constant Field Values

ON_FAILURE_PROCESSOR_TYPE_FIELD

public static final String ON_FAILURE_PROCESSOR_TYPE_FIELD

See Also:

• Constant Field Values

ON_FAILURE_PROCESSOR_TAG_FIELD

public static final String ON_FAILURE_PROCESSOR_TAG_FIELD

See Also:

• Constant Field Values

ON_FAILURE_PIPELINE_FIELD

public static final String ON_FAILURE_PIPELINE_FIELD

See Also:

• Constant Field Values

PROCESSOR_TYPE_EXCEPTION_HEADER

public static final String PROCESSOR_TYPE_EXCEPTION_HEADER

See Also:

• Constant Field Values

PROCESSOR_TAG_EXCEPTION_HEADER

public static final String PROCESSOR_TAG_EXCEPTION_HEADER

See Also:

• Constant Field Values

PIPELINE_ORIGIN_EXCEPTION_HEADER

public static final String PIPELINE_ORIGIN_EXCEPTION_HEADER

See Also:

• Constant Field Values

Constructor Details

CompoundProcessor

public CompoundProcessor(Processor... processors)

CompoundProcessor

public CompoundProcessor(boolean ignoreFailure,
 List<Processor> processors,
 List<Processor> onFailureProcessors)

Method Details

isIgnoreFailure

public boolean isIgnoreFailure()

getOnFailureProcessors

public List<Processor> getOnFailureProcessors()

getProcessors

public List<Processor> getProcessors()

flattenProcessors

public List<Processor> flattenProcessors()

getType

public String getType()

Description copied from interface: Processor

Gets the type of a processor

Specified by:

getType in interface Processor

getTag

public String getTag()

Description copied from interface: Processor

Gets the tag of a processor.

Specified by:

getTag in interface Processor

getDescription

public String getDescription()

Description copied from interface: Processor

Gets the description of a processor.

Specified by:

getDescription in interface Processor

isAsync

public boolean isAsync()

Specified by:

isAsync in interface Processor

execute

public IngestDocument execute(IngestDocument document)
                       throws Exception

Description copied from interface: Processor

Introspect and potentially modify the incoming data.

Specified by:

execute in interface Processor

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

execute

public void execute(IngestDocument ingestDocument,
 BiConsumer<IngestDocument,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).

Specified by:

execute in interface Processor