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

org.apache.nifi.processors.elasticsearch.AbstractElasticsearch5TransportClientProcessor

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 AbstractElasticsearch5TransportClientProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	DOCUMENT_ID
static String	ES_ERROR_MESSAGE
static String	ES_FILENAME
static String	ES_INDEX
static String	ES_REST_STATUS
static String	ES_TYPE
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
static String	UNABLE_TO_DELETE_DOCUMENT_MESSAGE

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
DeleteElasticsearch5()

Method Summary

Modifier and Type	Method and Description
void	closeClient() Dispose of ElasticSearch client
protected org.elasticsearch.action.delete.DeleteResponse	doDelete(org.elasticsearch.action.delete.DeleteRequestBuilder requestBuilder)
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)
protected org.elasticsearch.action.delete.DeleteRequestBuilder	prepareDeleteRequest(String index, String documentId, String documentType)

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

UNABLE_TO_DELETE_DOCUMENT_MESSAGE

public static final 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

relationships

private static final Set<Relationship> relationships

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

ES_ERROR_MESSAGE

public static final String ES_ERROR_MESSAGE

See Also:

Constant Field Values

ES_FILENAME

public static final String ES_FILENAME

See Also:

Constant Field Values

ES_INDEX

public static final String ES_INDEX

See Also:

Constant Field Values

ES_TYPE

public static final String ES_TYPE

See Also:

Constant Field Values

ES_REST_STATUS

public static final String ES_REST_STATUS

See Also:

Constant Field Values

Constructor Detail

DeleteElasticsearch5

public DeleteElasticsearch5()

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

prepareDeleteRequest

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

doDelete

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

Throws:

InterruptedException

ExecutionException

closeClient

@OnStopped
public void closeClient()

Description copied from class: AbstractElasticsearch5TransportClientProcessor

Dispose of ElasticSearch client

Overrides:

closeClient in class AbstractElasticsearch5TransportClientProcessor