Package org.elasticsearch.ingest

Class DropProcessor

java.lang.Object

org.elasticsearch.ingest.AbstractProcessor

org.elasticsearch.ingest.DropProcessor

All Implemented Interfaces:

Processor

public final class DropProcessor
extends AbstractProcessor

Drop processor only returns null for the execution result to indicate that any document executed by it should not be indexed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DropProcessor.Factory

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

Processor.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static 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.
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

Methods inherited from interface org.elasticsearch.ingest.Processor

execute

Field Details

TYPE

public static final String TYPE

See Also:

Constant Field Values

Method Details

execute

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

Exception

getType

public String getType()

Description copied from interface: Processor

Gets the type of a processor