GetElasticsearch 2.3.0¶

BUNDLE¶

org.apache.nifi | nifi-elasticsearch-restapi-nar

DESCRIPTION¶

Elasticsearch get processor that uses the official Elastic REST client libraries to fetch a single document from Elasticsearch by _id. Note that the full body of the document will be read into memory before being written to a FlowFile for transfer.

TAGS¶

elasticsearch, elasticsearch5, elasticsearch6, elasticsearch7, elasticsearch8, index, json, put, record

INPUT REQUIREMENT¶

ALLOWED

Supports Sensitive Dynamic Properties¶

false

PROPERTIES¶

Property	Description
el-rest-client-service	An Elasticsearch client service to use for running queries.
el-rest-fetch-index	The name of the index to use.
el-rest-type	The type of this document (used by Elasticsearch for indexing and searching).
get-es-attribute-name	The name of the FlowFile attribute to use for the retrieved document output.
get-es-destination	Indicates whether the retrieved document is written to the FlowFile content or a FlowFile attribute.
get-es-id	The _id of the document to retrieve.

RELATIONSHIPS¶

NAME	DESCRIPTION
not_found	A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster.
retry	All flowfiles that fail due to server/cluster availability go to this relationship.
failure	All flowfiles that fail for reasons unrelated to server availability go to this relationship.
document	Fetched documents are routed to this relationship.

WRITES ATTRIBUTES¶

NAME	DESCRIPTION
filename	The filename attribute is set to the document identifier
elasticsearch.index	The Elasticsearch index containing the document
elasticsearch.type	The Elasticsearch document type
elasticsearch.get.error	The error message provided by Elasticsearch if there is an error fetching the document.