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 NameAPI NameDefault ValueAllowable ValuesDescription
Elasticsearch URLelasticsearch-http-urlElasticsearch 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 ServiceSSL Context ServiceController 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 SetCharacter SetUTF-8Specifies the character set of the document data.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
UsernameUsernameUsername to access the Elasticsearch cluster
Supports Expression Language: true (will be evaluated using variable registry only)
PasswordPasswordPassword to access the Elasticsearch cluster
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Connection Timeoutelasticsearch-http-connect-timeout5 secsMax wait time for the connection to the Elasticsearch REST API.
Supports Expression Language: true (will be evaluated using variable registry only)
Response Timeoutelasticsearch-http-response-timeout15 secsMax wait time for a response from the Elasticsearch REST API.
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Configuration Serviceproxy-configuration-serviceController 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 Hostelasticsearch-http-proxy-hostThe fully qualified hostname or IP address of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Portelasticsearch-http-proxy-portThe port of the proxy server
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Usernameproxy-usernameProxy Username
Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Passwordproxy-passwordProxy Password
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
Identifier Attributeput-es-id-attrThe 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.
Indexput-es-indexThe name of the index to insert into
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Typeput-es-typeThe 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 Sizeput-es-batch-size100The 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 Operationput-es-index-opindexThe 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.

NameValueDescription
A URL query parameterThe value to set it toAdds 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:

NameDescription
retryA FlowFile is routed to this relationship if the database cannot be updated but attempting the operation again may succeed
successAll FlowFiles that are written to Elasticsearch are routed to this relationship
failureAll 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:

ResourceDescription
MEMORYAn instance of this component can cause high usage of this system resource. Multiple instances or high concurrency settings may result a degradation of performance.