GetElasticsearch

GetElasticsearch 2.0.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

Client Service
An Elasticsearch client service to use for running queries.

Display Name

Client Service

Description

An Elasticsearch client service to use for running queries.

API Name

el-rest-client-service

Service Interface

org.apache.nifi.elasticsearch.ElasticSearchClientService

Service Implementations

org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Index
The name of the index to use.

Display Name

Index

Description

The name of the index to use.

API Name

el-rest-fetch-index

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Type
The type of this document (used by Elasticsearch for indexing and searching).

Display Name

Type

Description

The type of this document (used by Elasticsearch for indexing and searching).

API Name

el-rest-type

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false
Attribute Name
The name of the FlowFile attribute to use for the retrieved document output.
Display Name

Attribute Name

Description

The name of the FlowFile attribute to use for the retrieved document output.

API Name

get-es-attribute-name

Default Value

elasticsearch.doc

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dependencies
- Destination is set to any of [flowfile-attribute]
Destination
Indicates whether the retrieved document is written to the FlowFile content or a FlowFile attribute.
Display Name

Destination

Description

Indicates whether the retrieved document is written to the FlowFile content or a FlowFile attribute.

API Name

get-es-destination

Default Value

flowfile-content

Allowable Values
- FlowFile Content
- FlowFile Attribute
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Document Id
The _id of the document to retrieve.

Display Name

Document Id

Description

The _id of the document to retrieve.

API Name

get-es-id

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true

Dynamic Properties

The name of a URL query parameter to add
Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing.

Name

The name of a URL query parameter to add

Description

Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing.

Value

The value of the URL query parameter

Expression Language Scope

FLOWFILE_ATTRIBUTES

Relationships

Name	Description
failure	All flowfiles that fail for reasons unrelated to server availability go to this relationship.
document	Fetched documents are routed to this relationship.
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.

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.