PutElasticsearchHttp

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: PutElasticsearchJson

Description:

Writes the contents of a FlowFile to Elasticsearch, using the specified parameters such as the index to insert into and the type of the document.

Tags:

elasticsearch, insert, update, upsert, delete, write, put, http

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
Elasticsearch URL	elasticsearch-http-url			Elasticsearch URL which will be connected to, including scheme (http, e.g.), host, and port. The default port for the REST API is 9200. Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context Service	SSL Context Service		Controller Service API: SSLContextService Implementations: StandardRestrictedSSLContextService StandardSSLContextService	The SSL Context Service used to provide client certificate information for TLS/SSL connections. This service only applies if the Elasticsearch endpoint(s) have been secured with TLS/SSL.
Character Set	Character Set	UTF-8		Specifies the character set of the document data. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Username	Username			Username to access the Elasticsearch cluster Supports Expression Language: true (will be evaluated using variable registry only)
Password	Password			Password to access the Elasticsearch cluster Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
Connection Timeout	elasticsearch-http-connect-timeout	5 secs		Max wait time for the connection to the Elasticsearch REST API. Supports Expression Language: true (will be evaluated using variable registry only)
Response Timeout	elasticsearch-http-response-timeout	15 secs		Max wait time for a response from the Elasticsearch REST API. Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Configuration Service	proxy-configuration-service		Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService	Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor.
Proxy Host	elasticsearch-http-proxy-host			The fully qualified hostname or IP address of the proxy server Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Port	elasticsearch-http-proxy-port			The port of the proxy server Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Username	proxy-username			Proxy Username Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Password	proxy-password			Proxy Password Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
Identifier Attribute	put-es-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	put-es-index			The name of the index to insert into Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Type	put-es-type			The type of this document (required by Elasticsearch versions < 7.0 for indexing and searching). This must be unset or '_doc' for Elasticsearch 7.0+. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Batch Size	put-es-batch-size	100		The preferred number of flow files to put to the database in a single transaction. Note that the contents of the flow files will be stored in memory until the bulk operation is performed. Also the results should be returned in the same order the flow files were received. Supports Expression Language: true (will be evaluated using variable registry only)
Index Operation	put-es-index-op	index		The type of the operation used to index (create, index, update, upsert, delete) Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

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
A URL query parameter	The value to set it to	Adds the specified property name/value as a query parameter in the Elasticsearch URL used for processing Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

Name	Description
retry	A FlowFile is routed to this relationship if the database cannot be updated but attempting the operation again may succeed
success	All FlowFiles that are written to Elasticsearch are routed to this relationship
failure	All FlowFiles that cannot be written to Elasticsearch are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

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	An instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.