org.apache.nifi.processors.elasticsearch

Class PutElasticsearchHttpRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.elasticsearch.AbstractElasticsearchProcessor

org.apache.nifi.processors.elasticsearch.AbstractElasticsearchHttpProcessor

org.apache.nifi.processors.elasticsearch.PutElasticsearchHttpRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @EventDriven
 @Tags(value={"elasticsearch","insert","update","upsert","delete","write","put","http","record"})
 @CapabilityDescription(value="Writes the records from a FlowFile into to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document, as well as the operation type (index, upsert, delete, etc.). Note: The Bulk API is used to send the records. This means that the entire contents of the incoming flow file are read into memory, and each record is transformed into a JSON document which is added to a single HTTP request body. For very large flow files (files with a large number of records, e.g.), this could cause memory usage issues.")
 @DynamicProperty(name="A URL query parameter",
                 value="The value to set it to",
                 expressionLanguageScope=VARIABLE_REGISTRY,
                 description="Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing")
public class PutElasticsearchHttpRecord
extends AbstractElasticsearchHttpProcessor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AllowableValue	ALWAYS_SUPPRESS
private com.fasterxml.jackson.core.JsonFactory	factory
(package private) static PropertyDescriptor	ID_RECORD_PATH
(package private) static PropertyDescriptor	INDEX
(package private) static PropertyDescriptor	INDEX_OP
(package private) static AllowableValue	NEVER_SUPPRESS
private String	nullSuppression
private static List<PropertyDescriptor>	propertyDescriptors
(package private) static PropertyDescriptor	RECORD_READER
private RecordPathCache	recordPathCache
static Relationship	REL_FAILURE
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships
(package private) static AllowableValue	SUPPRESS_MISSING
(package private) static PropertyDescriptor	SUPPRESS_NULLS
(package private) static PropertyDescriptor	TYPE

Fields inherited from class org.apache.nifi.processors.elasticsearch.AbstractElasticsearchHttpProcessor

COMMON_PROPERTY_DESCRIPTORS, CONNECT_TIMEOUT, ES_URL, FIELD_INCLUDE_QUERY_PARAM, PROXY_CONFIGURATION_SERVICE, PROXY_HOST, PROXY_PASSWORD, PROXY_PORT, PROXY_USERNAME, QUERY_QUERY_PARAM, RESPONSE_TIMEOUT, SIZE_QUERY_PARAM, SORT_QUERY_PARAM

Fields inherited from class org.apache.nifi.processors.elasticsearch.AbstractElasticsearchProcessor

CHARSET, PASSWORD, PROP_SSL_CONTEXT_SERVICE, USERNAME

Constructor Summary

Constructors

Constructor and Description
PutElasticsearchHttpRecord()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
void	setup(ProcessContext context)
private void	writeArray(Object[] values, String fieldName, com.fasterxml.jackson.core.JsonGenerator generator, DataType elementType)
private void	writeRecord(Record record, RecordSchema writeSchema, com.fasterxml.jackson.core.JsonGenerator generator)
private void	writeValue(com.fasterxml.jackson.core.JsonGenerator generator, Object value, String fieldName, DataType dataType)

Methods inherited from class org.apache.nifi.processors.elasticsearch.AbstractElasticsearchHttpProcessor

buildBulkCommand, createElasticsearchClient, getClient, getSupportedDynamicPropertyDescriptor, isSuccess, parseJsonResponse, sendRequestToElasticsearch

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

REL_RETRY

public static final Relationship REL_RETRY

RECORD_READER

static final PropertyDescriptor RECORD_READER

ID_RECORD_PATH

static final PropertyDescriptor ID_RECORD_PATH

INDEX

static final PropertyDescriptor INDEX

TYPE

static final PropertyDescriptor TYPE

INDEX_OP

static final PropertyDescriptor INDEX_OP

ALWAYS_SUPPRESS

static final AllowableValue ALWAYS_SUPPRESS

NEVER_SUPPRESS

static final AllowableValue NEVER_SUPPRESS

SUPPRESS_MISSING

static final AllowableValue SUPPRESS_MISSING

SUPPRESS_NULLS

static final PropertyDescriptor SUPPRESS_NULLS

relationships

private static final Set<Relationship> relationships

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

recordPathCache

private volatile RecordPathCache recordPathCache

factory

private final com.fasterxml.jackson.core.JsonFactory factory

nullSuppression

private volatile String nullSuppression

Constructor Detail

PutElasticsearchHttpRecord

public PutElasticsearchHttpRecord()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractElasticsearchHttpProcessor

setup

@OnScheduled
public void setup(ProcessContext context)

Overrides:

setup in class AbstractElasticsearchProcessor

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

writeRecord

private void writeRecord(Record record,
                         RecordSchema writeSchema,
                         com.fasterxml.jackson.core.JsonGenerator generator)
                  throws IOException

Throws:

IOException

writeValue

private void writeValue(com.fasterxml.jackson.core.JsonGenerator generator,
                        Object value,
                        String fieldName,
                        DataType dataType)
                 throws IOException

Throws:

IOException

writeArray

private void writeArray(Object[] values,
                        String fieldName,
                        com.fasterxml.jackson.core.JsonGenerator generator,
                        DataType elementType)
                 throws IOException

Throws:

IOException