public final class Pipeline
extends java.lang.Object
Processor
instances grouped under a unique id.Modifier and Type | Class | Description |
---|---|---|
static class |
Pipeline.Factory |
Constructor | Description |
---|---|
Pipeline(java.lang.String id,
java.lang.String description,
java.lang.Integer version,
CompoundProcessor compoundProcessor) |
Modifier and Type | Method | Description |
---|---|---|
void |
execute(IngestDocument ingestDocument) |
Modifies the data of a document to be indexed based on the processor this pipeline holds
|
java.util.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 |
java.lang.String |
getDescription() |
An optional description of what this pipeline is doing to the data gets processed by this pipeline.
|
java.lang.String |
getId() |
The unique id of this pipeline
|
java.util.List<Processor> |
getOnFailureProcessors() |
Unmodifiable list containing each on_failure processor that operates on the data in case of
exception thrown in pipeline processors
|
java.util.List<Processor> |
getProcessors() |
Unmodifiable list containing each processor that operates on the data.
|
java.lang.Integer |
getVersion() |
An optional version stored with the pipeline so that it can be used to determine if the pipeline should be updated / replaced.
|
public Pipeline(java.lang.String id, @Nullable java.lang.String description, @Nullable java.lang.Integer version, CompoundProcessor compoundProcessor)
public void execute(IngestDocument ingestDocument) throws java.lang.Exception
java.lang.Exception
public java.lang.String getId()
@Nullable public java.lang.String getDescription()
@Nullable public java.lang.Integer getVersion()
null
if not supplied.public CompoundProcessor getCompoundProcessor()
CompoundProcessor
containing the Pipeline's processorspublic java.util.List<Processor> getProcessors()
public java.util.List<Processor> getOnFailureProcessors()
public java.util.List<Processor> flattenAllProcessors()