GetElasticsearch 2025.10.9.21

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, elasticsearch7, elasticsearch8, elasticsearch9, index, json, put, record

Input Requirement

ALLOWED

Supports Sensitive Dynamic Properties

false

Properties

PropertyDescription
Attribute NameThe name of the FlowFile attribute to use for the retrieved document output.
Client ServiceAn Elasticsearch client service to use for running queries.
DestinationIndicates whether the retrieved document is written to the FlowFile content or a FlowFile attribute.
Document IdThe _id of the document to retrieve.
IndexThe name of the index to use.
TypeThe type of this document (used by Elasticsearch for indexing and searching).

Relationships

NameDescription
documentFetched documents are routed to this relationship.
failureAll flowfiles that fail for reasons unrelated to server availability go to this relationship.
not_foundA FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster.
retryAll flowfiles that fail due to server/cluster availability go to this relationship.

Writes attributes

NameDescription
filenameThe filename attribute is set to the document identifier
elasticsearch.indexThe Elasticsearch index containing the document
elasticsearch.typeThe Elasticsearch document type
elasticsearch.get.errorThe error message provided by Elasticsearch if there is an error fetching the document.

See also