org.apache.nifi.processors.elasticsearch

Class ScrollElasticsearchHttp

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

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @EventDriven
 @SupportsBatching
 @Tags(value={"elasticsearch","query","scroll","read","get","http"})
 @CapabilityDescription(value="Scrolls through an Elasticsearch query using the specified connection properties. This processor is intended to be run on the primary node, and is designed for scrolling through huge result sets, as in the case of a reindex.  The state must be cleared before another query can be run.  Each page of results is returned, wrapped in a JSON object like so: { \"hits\" : [ <doc1>, <doc2>, <docn> ] }.  Note that the full body of each page of documents will be read into memory before being written to a Flow File for transfer.")
 @WritesAttribute(attribute="es.index",description="The Elasticsearch index containing the document") @WritesAttribute(attribute="es.type",description="The Elasticsearch document type")
 @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")
 @Stateful(description="After each successful scroll page, the latest scroll_id is persisted in scrollId as input for the next scroll call.  Once the entire query is complete, finishedQuery state will be set to true, and the processor will not execute unless this is cleared.",
          scopes=LOCAL)
public class ScrollElasticsearchHttp
extends AbstractElasticsearchHttpProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	FIELDS
static PropertyDescriptor	INDEX
static PropertyDescriptor	PAGE_SIZE
static PropertyDescriptor	QUERY
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
static PropertyDescriptor	SCROLL_DURATION
static PropertyDescriptor	SORT
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
ScrollElasticsearchHttp()

Method Summary

Modifier and Type	Method and Description
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, customValidate, 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

QUERY

public static final PropertyDescriptor QUERY

SCROLL_DURATION

public static final PropertyDescriptor SCROLL_DURATION

INDEX

public static final PropertyDescriptor INDEX

TYPE

public static final PropertyDescriptor TYPE

FIELDS

public static final PropertyDescriptor FIELDS

SORT

public static final PropertyDescriptor SORT

PAGE_SIZE

public static final PropertyDescriptor PAGE_SIZE

Constructor Detail

ScrollElasticsearchHttp

public ScrollElasticsearchHttp()

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

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