org.apache.nifi.processors.elasticsearch

Class FetchElasticsearch5

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.elasticsearch.AbstractElasticsearch5Processor

org.apache.nifi.processors.elasticsearch.AbstractElasticsearch5TransportClientProcessor

org.apache.nifi.processors.elasticsearch.FetchElasticsearch5

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @EventDriven
 @SupportsBatching
 @Tags(value={"elasticsearch","elasticsearch 5","fetch","read","get"})
 @CapabilityDescription(value="Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. If the cluster has been configured for authorization and/or secure transport (SSL/TLS), and the X-Pack plugin is available, secure connections can be made. This processor supports Elasticsearch 5.x clusters.")
 @WritesAttribute(attribute="filename",description="The filename attributes is set to the document identifier") @WritesAttribute(attribute="es.index",description="The Elasticsearch index containing the document") @WritesAttribute(attribute="es.type",description="The Elasticsearch document type")
 @SeeAlso(value={DeleteElasticsearch5.class,PutElasticsearch5.class})
public class FetchElasticsearch5
extends AbstractElasticsearch5TransportClientProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DOC_ID
static PropertyDescriptor	INDEX
private static List<PropertyDescriptor>	propertyDescriptors
static Relationship	REL_FAILURE
static Relationship	REL_NOT_FOUND
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships
static PropertyDescriptor	TYPE

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

CLUSTER_NAME, esClient, esHosts, HOSTS, PING_TIMEOUT, PROP_XPACK_LOCATION, SAMPLER_INTERVAL

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

CHARSET, PASSWORD, PROP_SSL_CONTEXT_SERVICE, USERNAME

Constructor Summary

Constructors

Constructor and Description
FetchElasticsearch5()

Method Summary

Modifier and Type	Method and Description
void	closeClient() Dispose of ElasticSearch client
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)

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

createElasticsearchClient, getTransportClient

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

customValidate, setup

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, getSupportedDynamicPropertyDescriptor, 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

REL_NOT_FOUND

public static final Relationship REL_NOT_FOUND

DOC_ID

public static final PropertyDescriptor DOC_ID

INDEX

public static final PropertyDescriptor INDEX

TYPE

public static final PropertyDescriptor TYPE

relationships

private static final Set<Relationship> relationships

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

Constructor Detail

FetchElasticsearch5

public FetchElasticsearch5()

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

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

closeClient

@OnStopped
public void closeClient()

Dispose of ElasticSearch client

Overrides:

closeClient in class AbstractElasticsearch5TransportClientProcessor