org.apache.nifi.processors.elasticsearch

Class DeleteElasticsearch5

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.elasticsearch.DeleteElasticsearch5

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @EventDriven
 @Tags(value={"elasticsearch","elasticsearch 5","delete","remove"})
 @CapabilityDescription(value="Delete a document from Elasticsearch 5.0 by document id. 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.")
 @WritesAttribute(attribute="es.error.message",description="The message attribute in case of error") @WritesAttribute(attribute="filename",description="The filename attribute which 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") @WritesAttribute(attribute="es.rest.status",description="The filename attribute with rest status")
 @SeeAlso(value={FetchElasticsearch5.class,PutElasticsearch5.class})
public class DeleteElasticsearch5
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
protected static PropertyDescriptor	CHARSET
protected static PropertyDescriptor	CLUSTER_NAME
static PropertyDescriptor	DOCUMENT_ID
static java.lang.String	ES_ERROR_MESSAGE
static java.lang.String	ES_FILENAME
static java.lang.String	ES_INDEX
static java.lang.String	ES_REST_STATUS
static java.lang.String	ES_TYPE
protected java.util.concurrent.atomic.AtomicReference<org.elasticsearch.client.Client>	esClient
protected java.util.List<java.net.InetSocketAddress>	esHosts
protected static PropertyDescriptor	HOSTS
static PropertyDescriptor	INDEX
static PropertyDescriptor	PASSWORD
protected static PropertyDescriptor	PING_TIMEOUT
static PropertyDescriptor	PROP_SSL_CONTEXT_SERVICE
static PropertyDescriptor	PROP_XPACK_LOCATION
static Relationship	REL_FAILURE
static Relationship	REL_NOT_FOUND
static Relationship	REL_RETRY
static Relationship	REL_SUCCESS
protected static PropertyDescriptor	SAMPLER_INTERVAL
static PropertyDescriptor	TYPE
static java.lang.String	UNABLE_TO_DELETE_DOCUMENT_MESSAGE
static PropertyDescriptor	USERNAME

Constructor Summary

Constructors

Constructor and Description
DeleteElasticsearch5()

Method Summary

Modifier and Type	Method and Description
void	closeClient() Dispose of ElasticSearch client
protected void	createElasticsearchClient(ProcessContext context) Instantiate ElasticSearch Client.
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
protected org.elasticsearch.action.delete.DeleteResponse	doDelete(org.elasticsearch.action.delete.DeleteRequestBuilder requestBuilder)
java.util.Set<Relationship>	getRelationships()
java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected org.elasticsearch.client.Client	getTransportClient(org.elasticsearch.common.settings.Settings.Builder settingsBuilder, java.lang.String xPackPath, java.lang.String username, java.lang.String password, java.util.List<java.net.InetSocketAddress> esHosts, ComponentLog log)
void	onTrigger(ProcessContext context, ProcessSession session)
protected org.elasticsearch.action.delete.DeleteRequestBuilder	prepareDeleteRequest(java.lang.String index, java.lang.String documentId, java.lang.String documentType)
void	setup(ProcessContext context)

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

UNABLE_TO_DELETE_DOCUMENT_MESSAGE

public static final java.lang.String UNABLE_TO_DELETE_DOCUMENT_MESSAGE

See Also:

Constant Field Values

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

DOCUMENT_ID

public static final PropertyDescriptor DOCUMENT_ID

INDEX

public static final PropertyDescriptor INDEX

TYPE

public static final PropertyDescriptor TYPE

ES_ERROR_MESSAGE

public static final java.lang.String ES_ERROR_MESSAGE

See Also:

Constant Field Values

ES_FILENAME

public static final java.lang.String ES_FILENAME

See Also:

Constant Field Values

ES_INDEX

public static final java.lang.String ES_INDEX

See Also:

Constant Field Values

ES_TYPE

public static final java.lang.String ES_TYPE

See Also:

Constant Field Values

ES_REST_STATUS

public static final java.lang.String ES_REST_STATUS

See Also:

Constant Field Values

CLUSTER_NAME

protected static final PropertyDescriptor CLUSTER_NAME

HOSTS

protected static final PropertyDescriptor HOSTS

PROP_XPACK_LOCATION

public static final PropertyDescriptor PROP_XPACK_LOCATION

PING_TIMEOUT

protected static final PropertyDescriptor PING_TIMEOUT

SAMPLER_INTERVAL

protected static final PropertyDescriptor SAMPLER_INTERVAL

esClient

protected final java.util.concurrent.atomic.AtomicReference<org.elasticsearch.client.Client> esClient

esHosts

protected java.util.List<java.net.InetSocketAddress> esHosts

PROP_SSL_CONTEXT_SERVICE

public static final PropertyDescriptor PROP_SSL_CONTEXT_SERVICE

CHARSET

protected static final PropertyDescriptor CHARSET

USERNAME

public static final PropertyDescriptor USERNAME

PASSWORD

public static final PropertyDescriptor PASSWORD

Constructor Detail

DeleteElasticsearch5

public DeleteElasticsearch5()

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

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

prepareDeleteRequest

protected org.elasticsearch.action.delete.DeleteRequestBuilder prepareDeleteRequest(java.lang.String index,
                                                                                    java.lang.String documentId,
                                                                                    java.lang.String documentType)

doDelete

protected org.elasticsearch.action.delete.DeleteResponse doDelete(org.elasticsearch.action.delete.DeleteRequestBuilder requestBuilder)
                                                           throws java.lang.InterruptedException,
                                                                  java.util.concurrent.ExecutionException

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

closeClient

@OnStopped
public void closeClient()

Dispose of ElasticSearch client

createElasticsearchClient

protected void createElasticsearchClient(ProcessContext context)
                                  throws ProcessException

Instantiate ElasticSearch Client. This should be called by subclasses' @OnScheduled method to create a client if one does not yet exist. If called when scheduled, closeClient() should be called by the subclasses' @OnStopped method so the client will be destroyed when the processor is stopped.

Parameters:

context - The context for this processor

Throws:

ProcessException - if an error occurs while creating an Elasticsearch client

getTransportClient

protected org.elasticsearch.client.Client getTransportClient(org.elasticsearch.common.settings.Settings.Builder settingsBuilder,
                                                             java.lang.String xPackPath,
                                                             java.lang.String username,
                                                             java.lang.String password,
                                                             java.util.List<java.net.InetSocketAddress> esHosts,
                                                             ComponentLog log)
                                                      throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

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 AbstractConfigurableComponent

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

public void setup(ProcessContext context)