PutElasticsearchJson

Description:

An Elasticsearch put processor that uses the official Elastic REST client libraries.

Tags:

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

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Identifier Attribute	put-es-json-id-attr			The name of the FlowFile attribute containing the identifier for the document. If the Index Operation is "index", this property may be left empty or evaluate to an empty value, in which case the document's identifier will be auto-generated by Elasticsearch. For all other Index Operations, the attribute must evaluate to a non-empty value.
Index Operation	put-es-record-index-op	index		The type of the operation used to index (create, delete, index, update, upsert) Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Index	el-rest-fetch-index			The name of the index to use. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Type	el-rest-type			The type of this document (used by Elasticsearch for indexing and searching). Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Script	put-es-json-script			The script for the document update/upsert. Only applies to Update/Upsert operations. Must be parsable as JSON Object. If left blank, the FlowFile content will be used for document update/upsert Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Scripted Upsert	put-es-json-scripted-upsert	false	true false	Whether to add the scripted_upsert flag to the Upsert Operation. Forces Elasticsearch to execute the Script whether or not the document exists, defaults to false. If the Upsert Document provided (from FlowFile content) will be empty, but sure to set the Client Service controller service's Suppress Null/Empty Values to Never Suppress or no "upsert" doc will be, included in the request to Elasticsearch and the operation will not create a new document for the script to execute against, resulting in a "not_found" error Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Dynamic Templates	put-es-json-dynamic_templates			The dynamic_templates for the document. Must be parsable as a JSON Object. Requires Elasticsearch 7+ Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Batch Size	put-es-record-batch-size	100		The preferred number of FlowFiles to send over in a single batch. Supports Expression Language: true (will be evaluated using variable registry only)
Character Set	put-es-json-charset	UTF-8		Specifies the character set of the document data. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Client Service	el-rest-client-service		Controller Service API: ElasticSearchClientService Implementation: ElasticSearchClientServiceImpl	An Elasticsearch client service to use for running queries.
Log Error Responses	put-es-record-log-error-responses	false	true false	If this is enabled, errors will be logged to the NiFi logs at the error log level. Otherwise, they will only be logged if debug logging is enabled on NiFi as a whole. The purpose of this option is to give the user the ability to debug failed operations without having to turn on debug logging.
Output Error Responses	put-es-output-error-responses	false	true false	If this is enabled, response messages from Elasticsearch marked as "error" will be output to the "error_responses" relationship.This does not impact the output of flowfiles to the "success" or "errors" relationships
Output Error Documents	put-es-json-error-documents	false	true false	If this configuration property is true, the response from Elasticsearch will be examined for failed documents and the FlowFile(s) associated with the failed document(s) will be sent to the "errors" relationship with "elasticsearch.bulk.error" attributes.
Treat "Not Found" as Success	put-es-json-not_found-is-error	true	true false	If true, "not_found" Elasticsearch Document associated FlowFiles will be routed to the "success" relationship, otherwise to the "errors" relationship. If Output Error Responses is "true" then "not_found" responses from Elasticsearch will be sent to the error_responses relationship This Property is only considered if the [Output Error Documents] Property has a value of "true".

Dynamic Properties:

Supports Sensitive Dynamic Properties: No

Dynamic Properties allow the user to specify both the name and value of a property.

Name	Value	Description
The name of the Bulk request header	The value of the Bulk request header	Prefix: BULK: - adds the specified property name/value as a Bulk request header in the Elasticsearch Bulk API body used for processing. These parameters will override any matching parameters in the _bulk request body. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
The name of a URL query parameter to add	The value of the URL query parameter	Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing. These parameters will override any matching parameters in the _bulk request body. If FlowFiles are batched, only the first FlowFile in the batch is used to evaluate property values. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

Name	Description
retry	All flowfiles that fail due to server/cluster availability go to this relationship.
success	All flowfiles that succeed in being transferred into Elasticsearch go here. Documents received by the Elasticsearch _bulk API may still result in errors on the Elasticsearch side. The Elasticsearch response will need to be examined to determine whether any Document(s)/Record(s) resulted in errors.
failure	All flowfiles that fail for reasons unrelated to server availability go to this relationship.
errors	If a "Output Error Documents" is set, any FlowFile(s) corresponding to Elasticsearch document(s) that resulted in an "error" (within Elasticsearch) will be routed here.

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
elasticsearch.put.error	The error message if there is an issue parsing the FlowFile, sending the parsed document to Elasticsearch or parsing the Elasticsearch response
elasticsearch.bulk.error	The _bulk response if there was an error during processing the document within Elasticsearch.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

Resource	Description
MEMORY	The Batch of FlowFiles will be stored in memory until the bulk operation is performed.