Module org.elasticsearch.server

Package org.elasticsearch.ingest

Class PipelineConfiguration

java.lang.Object

org.elasticsearch.ingest.PipelineConfiguration

All Implemented Interfaces:

Diffable<PipelineConfiguration>, SimpleDiffable<PipelineConfiguration>, Writeable, ToXContent, ToXContentObject

public final class PipelineConfiguration
extends Object
implements SimpleDiffable<PipelineConfiguration>, ToXContentObject

Encapsulates a pipeline's id and configuration as a loosely typed map -- see Pipeline for the parsed and processed object(s) that a pipeline configuration will become. This class is used for things like keeping track of pipelines in the cluster state (where a pipeline is 'just some json') whereas the Pipeline class is used in the actual processing of ingest documents through pipelines in the IngestService.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
PipelineConfiguration(String id, Map<String,Object> config)
PipelineConfiguration(String id, BytesReference config, XContentType xContentType)	A convenience constructor that parses some bytes as a map representing a pipeline's config and then delegates to the conventional PipelineConfiguration(String, Map) constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Object>	getConfig()
Map<String,Object>	getConfig(boolean unmodifiable)
String	getId()
static ContextParser<Void,PipelineConfiguration>	getParser()
Integer	getVersion()
int	hashCode()
static Diff<PipelineConfiguration>	readDiffFrom(StreamInput in)
static PipelineConfiguration	readFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

PipelineConfiguration

public PipelineConfiguration(String id,
 Map<String,Object> config)

PipelineConfiguration

public PipelineConfiguration(String id,
 BytesReference config,
 XContentType xContentType)

A convenience constructor that parses some bytes as a map representing a pipeline's config and then delegates to the conventional PipelineConfiguration(String, Map) constructor.

Parameters:

id - the id of the pipeline

config - a parse-able bytes reference that will return a pipeline configuration

xContentType - the content-type to use while parsing the pipeline configuration

Method Details

getParser

public static ContextParser<Void,PipelineConfiguration> getParser()

getId

public String getId()

getConfig

public Map<String,Object> getConfig()

Returns:

a reference to the unmodifiable configuration map for this pipeline

getConfig

public Map<String,Object> getConfig(boolean unmodifiable)

Parameters:

unmodifiable - whether the returned map should be unmodifiable or not

Returns:

a reference to the unmodifiable config map (if unmodifiable is true) or a reference to a freshly-created mutable deep copy of the config map (if unmodifiable is false)

getVersion

public Integer getVersion()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public static PipelineConfiguration readFrom(StreamInput in)
                                      throws IOException

Throws:

IOException

readDiffFrom

public static Diff<PipelineConfiguration> readDiffFrom(StreamInput in)
                                                throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object