org.apache.nifi.processors.elasticsearch

Class QueryElasticsearchHttp

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

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_ALLOWED)
 @EventDriven
 @SupportsBatching
 @Tags(value={"elasticsearch","query","read","get","http"})
 @CapabilityDescription(value="Queries Elasticsearch using the specified connection properties. Note that the full body of each page of documents will be read into memory before being written to Flow Files for transfer.  Also note that the Elasticsearch max_result_window index setting is the upper bound on the number of records that can be retrieved using this query.  To retrieve more records, use the ScrollElasticsearchHttp processor.")
 @WritesAttribute(attribute="filename",description="The filename attribute is set to the document identifier") @WritesAttribute(attribute="es.query.hitcount",description="The number of hits for a query") @WritesAttribute(attribute="es.id",description="The Elasticsearch document identifier") @WritesAttribute(attribute="es.index",description="The Elasticsearch index containing the document") @WritesAttribute(attribute="es.query.url",description="The Elasticsearch query that was built") @WritesAttribute(attribute="es.type",description="The Elasticsearch document type") @WritesAttribute(attribute="es.result.*",description="If Target is \'Flow file attributes\', the JSON attributes of each result will be placed into corresponding attributes with this prefix.")
 @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 QueryElasticsearchHttp
extends AbstractElasticsearchHttpProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryElasticsearchHttp.QueryInfoRouteStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AllowableValue	ALWAYS
private static String	ATTRIBUTE_PREFIX
static PropertyDescriptor	FIELDS
private static String	FROM_QUERY_PARAM
static PropertyDescriptor	INDEX
static PropertyDescriptor	LIMIT
(package private) static AllowableValue	NEVER
(package private) static AllowableValue	NO_HITS
static PropertyDescriptor	PAGE_SIZE
private static List<PropertyDescriptor>	propertyDescriptors
static PropertyDescriptor	QUERY
private QueryElasticsearchHttp.QueryInfoRouteStrategy	queryInfoRouteStrategy
static Relationship	REL_FAILURE
static Relationship	REL_QUERY_INFO
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	ROUTING_QUERY_INFO_STRATEGY
static PropertyDescriptor	SORT
static PropertyDescriptor	TARGET
static String	TARGET_FLOW_FILE_ATTRIBUTES
static String	TARGET_FLOW_FILE_CONTENT
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
QueryElasticsearchHttp()

Method Summary

Modifier and Type	Method and Description
private URL	buildRequestURL(String baseUrl, String query, String index, String type, String fields, String sort, int pageSize, int fromIndex, ProcessContext context)
private int	getPage(okhttp3.Response getResponse, URL url, ProcessContext context, ProcessSession session, FlowFile flowFile, ComponentLog logger, long startNanos, boolean targetIsContent, int priorResultCount)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onTrigger(ProcessContext context, ProcessSession session)
void	setup(ProcessContext context)

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

buildBulkCommand, 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, 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, validate

Field Detail

FROM_QUERY_PARAM

private static final String FROM_QUERY_PARAM

See Also:

Constant Field Values

TARGET_FLOW_FILE_CONTENT

public static final String TARGET_FLOW_FILE_CONTENT

See Also:

Constant Field Values

TARGET_FLOW_FILE_ATTRIBUTES

public static final String TARGET_FLOW_FILE_ATTRIBUTES

See Also:

Constant Field Values

ATTRIBUTE_PREFIX

private static final String ATTRIBUTE_PREFIX

See Also:

Constant Field Values

ALWAYS

static final AllowableValue ALWAYS

NEVER

static final AllowableValue NEVER

NO_HITS

static final AllowableValue NO_HITS

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

REL_RETRY

public static final Relationship REL_RETRY

REL_QUERY_INFO

public static final Relationship REL_QUERY_INFO

QUERY

public static final PropertyDescriptor QUERY

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

LIMIT

public static final PropertyDescriptor LIMIT

TARGET

public static final PropertyDescriptor TARGET

ROUTING_QUERY_INFO_STRATEGY

public static final PropertyDescriptor ROUTING_QUERY_INFO_STRATEGY

relationships

private volatile Set<Relationship> relationships

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

queryInfoRouteStrategy

private QueryElasticsearchHttp.QueryInfoRouteStrategy queryInfoRouteStrategy

Constructor Detail

QueryElasticsearchHttp

public QueryElasticsearchHttp()

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

setup

@OnScheduled
public void setup(ProcessContext context)

Overrides:

setup in class AbstractElasticsearchProcessor

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               String oldValue,
                               String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getPage

private int getPage(okhttp3.Response getResponse,
                    URL url,
                    ProcessContext context,
                    ProcessSession session,
                    FlowFile flowFile,
                    ComponentLog logger,
                    long startNanos,
                    boolean targetIsContent,
                    int priorResultCount)
             throws IOException

Throws:

IOException

buildRequestURL

private URL buildRequestURL(String baseUrl,
                            String query,
                            String index,
                            String type,
                            String fields,
                            String sort,
                            int pageSize,
                            int fromIndex,
                            ProcessContext context)
                     throws MalformedURLException

Throws:

MalformedURLException