Package org.opensearch.ingest

Class ConditionalProcessor

java.lang.Object

org.opensearch.ingest.AbstractProcessor

org.opensearch.ingest.ConditionalProcessor

All Implemented Interfaces:

Processor, WrappingProcessor

public class ConditionalProcessor
extends AbstractProcessor
implements WrappingProcessor

Nested Class Summary

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

Processor.Factory, Processor.Parameters

Field Summary

Fields inherited from class org.opensearch.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	getCondition()
Processor	getInnerProcessor()	Method for retrieving the inner processor from a wrapped processor.
java.lang.String	getType()	Gets the type of a processor

Methods inherited from class org.opensearch.ingest.AbstractProcessor

getDescription, getTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.ingest.Processor

getDescription, getTag

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

Specified by:

execute in interface Processor

execute

public IngestDocument execute(IngestDocument ingestDocument) throws java.lang.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:

java.lang.Exception

getInnerProcessor

public Processor getInnerProcessor()

Description copied from interface: WrappingProcessor

Method for retrieving the inner processor from a wrapped processor.

Specified by:

getInnerProcessor in interface WrappingProcessor

Returns:

the inner processor

getType

public java.lang.String getType()

Description copied from interface: Processor

Gets the type of a processor

Specified by:

getType in interface Processor

getCondition

public java.lang.String getCondition()