org.apache.nifi.processors.elasticsearch

Class PutElasticsearchHttp

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

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @EventDriven
 @SupportsBatching
 @Tags(value={"elasticsearch","insert","update","upsert","delete","write","put","http"})
 @CapabilityDescription(value="Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document.")
 @DynamicProperty(name="A URL query parameter",
                 value="The value to set it to",
                 supportsExpressionLanguage=true,
                 description="Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing")
public class PutElasticsearchHttp
extends AbstractElasticsearchHttpProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
static PropertyDescriptor	ID_ATTRIBUTE
static PropertyDescriptor	INDEX
static PropertyDescriptor	INDEX_OP
static Relationship	REL_FAILURE
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
static PropertyDescriptor	TYPE

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

CONNECT_TIMEOUT, ES_URL, PROXY_HOST, PROXY_PORT, RESPONSE_TIMEOUT

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

CHARSET, PASSWORD, PROP_SSL_CONTEXT_SERVICE, USERNAME

Constructor Summary

Constructors

Constructor and Description
PutElasticsearchHttp()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
java.util.Set<Relationship>	getRelationships()
java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onTrigger(ProcessContext context, ProcessSession session)
void	setup(ProcessContext context)

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

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

ID_ATTRIBUTE

public static final PropertyDescriptor ID_ATTRIBUTE

INDEX

public static final PropertyDescriptor INDEX

TYPE

public static final PropertyDescriptor TYPE

INDEX_OP

public static final PropertyDescriptor INDEX_OP

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

Constructor Detail

PutElasticsearchHttp

public PutElasticsearchHttp()

Method Detail

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

getSupportedPropertyDescriptors

public final java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractElasticsearchHttpProcessor

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

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