Module org.elasticsearch.server

Package org.elasticsearch.ingest

Class Pipeline

java.lang.Object

org.elasticsearch.ingest.Pipeline

public final class Pipeline
extends Object

A pipeline is a list of Processor instances grouped under a unique id.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPRECATED_KEY
static final String	DESCRIPTION_KEY
static final String	META_KEY
static final String	ON_FAILURE_KEY
static final String	PROCESSORS_KEY
static final String	VERSION_KEY

Constructor Summary

Constructors

Constructor	Description
Pipeline(String id, String description, Integer version, Map<String,Object> metadata, CompoundProcessor compoundProcessor)
Pipeline(String id, String description, Integer version, Map<String,Object> metadata, CompoundProcessor compoundProcessor, Boolean deprecated)

Method Summary

Modifier and Type	Method	Description
static Pipeline	create(String id, Map<String,Object> config, Map<String,Processor.Factory> processorFactories, ScriptService scriptService)
void	execute(IngestDocument ingestDocument, BiConsumer<IngestDocument,Exception> handler)	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.
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
Boolean	getDeprecated()
String	getDescription()	An optional description of what this pipeline is doing to the data gets processed by this pipeline.
String	getId()	The unique id of this pipeline
Map<String,Object>	getMetadata()
org.elasticsearch.ingest.IngestMetric	getMetrics()	The metrics associated with this pipeline.
List<Processor>	getOnFailureProcessors()	Unmodifiable list containing each on_failure processor that operates on the data in case of exception thrown in pipeline processors
List<Processor>	getProcessors()	Unmodifiable list containing each processor that operates on the data.
Integer	getVersion()	An optional version stored with the pipeline so that it can be used to determine if the pipeline should be updated / replaced.
boolean	isDeprecated()

Methods inherited from class java.lang.Object

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

Field Details

DESCRIPTION_KEY

public static final String DESCRIPTION_KEY

See Also:

• Constant Field Values

PROCESSORS_KEY

public static final String PROCESSORS_KEY

See Also:

• Constant Field Values

VERSION_KEY

public static final String VERSION_KEY

See Also:

• Constant Field Values

ON_FAILURE_KEY

public static final String ON_FAILURE_KEY

See Also:

• Constant Field Values

META_KEY

public static final String META_KEY

See Also:

• Constant Field Values

DEPRECATED_KEY

public static final String DEPRECATED_KEY

See Also:

• Constant Field Values

Constructor Details

Pipeline

public Pipeline(String id,
 @Nullable
 String description,
 @Nullable
 Integer version,
 @Nullable
 Map<String,Object> metadata,
 CompoundProcessor compoundProcessor)

Pipeline

public Pipeline(String id,
 @Nullable
 String description,
 @Nullable
 Integer version,
 @Nullable
 Map<String,Object> metadata,
 CompoundProcessor compoundProcessor,
 @Nullable
 Boolean deprecated)

Method Details

create

public static Pipeline create(String id,
 Map<String,Object> config,
 Map<String,Processor.Factory> processorFactories,
 ScriptService scriptService)
                       throws Exception

Throws:

Exception

execute

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

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.

getId

public String getId()

The unique id of this pipeline

getDescription

@Nullable
public String getDescription()

An optional description of what this pipeline is doing to the data gets processed by this pipeline.

getVersion

@Nullable
public 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.

getMetadata

@Nullable
public Map<String,Object> getMetadata()

getCompoundProcessor

public CompoundProcessor getCompoundProcessor()

Get the underlying CompoundProcessor containing the Pipeline's processors

getProcessors

public List<Processor> getProcessors()

Unmodifiable list containing each processor that operates on the data.

getOnFailureProcessors

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

getDeprecated

public Boolean getDeprecated()

isDeprecated

public boolean isDeprecated()