org.thales.punch.libraries.storm.bolt.elasticsearch

Class ElasticDocumentBuilder

java.lang.Object

org.thales.punch.libraries.storm.bolt.elasticsearch.ElasticDocumentBuilder

All Implemented Interfaces:

Serializable

public class ElasticDocumentBuilder
extends Object
implements Serializable

A utility class to build the final json document from the fields received in a storm tuple.

Author:

dimi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ElasticDocumentBuilder(org.thales.punch.settings.api.ISettingsMap componentSettings)

Method Summary

Modifier and Type	Method and Description
String	getDocumentIdField()
String	getDocumentType() Type mapping are deprecated since ES7, but we still need compatibility with older clusters.
String	getDocumentValue(org.apache.storm.tuple.Tuple t, String topologyError)
String	getId(org.apache.storm.tuple.Tuple tuple)
String	getIndex(org.apache.storm.tuple.Tuple t) Return the target index depending on the input configuration
boolean	isNullIdsAreErrors()

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticDocumentBuilder

public ElasticDocumentBuilder(org.thales.punch.settings.api.ISettingsMap componentSettings)

Parameters:

componentSettings - the elasticsearch component settings

Method Detail

getIndex

public String getIndex(org.apache.storm.tuple.Tuple t)

Return the target index depending on the input configuration

Parameters:

t - an input tuple

Returns:

the target index

getDocumentValue

public String getDocumentValue(org.apache.storm.tuple.Tuple t,
                               String topologyError)

Parameters:

t - an incoming tuple

topologyError - an optional string that will be recorded in a special error field in the document. if null, nothing will be appended.

Returns:

the corresponding json document

getDocumentType

public String getDocumentType()

Type mapping are deprecated since ES7, but we still need compatibility with older clusters.

Returns:

the elasticsearch document type or doc

getDocumentIdField

public String getDocumentIdField()

Returns:

null or name of input tuple field that contains a provided id

getId

public String getId(org.apache.storm.tuple.Tuple tuple)

Parameters:

tuple - tuple

Returns:

the elasticsearch document id or null

isNullIdsAreErrors

public boolean isNullIdsAreErrors()

Returns:

true if a null or empty id is not expected (and should cause an error message in addition to any id generation process)