This processor is deprecated and may be removed in future releases.
Please consider using one the following alternatives: GetElasticsearch
Retrieves a document from Elasticsearch using the specified connection properties and the identifier of the document to retrieve. Note that the full body of the document will be read into memory before being written to a Flow File for transfer.
elasticsearch, fetch, read, get, http
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: StandardSSLContextService StandardRestrictedSSLContextService | 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: SOCKS, HTTP + AuthN 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) | ||
| Document Identifier | fetch-es-doc-id | The identifier of the document to be fetched Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Index | fetch-es-index | The name of the index to read from. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Type | fetch-es-type | The type of document/fetch (if unset, the first document matching the identifier across _all types will be retrieved). This should be unset, '_doc' or '_source' for Elasticsearch 7.0+. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) | ||
| Fields | fetch-es-fields | A comma-separated list of fields to retrieve from the document. If the Fields property is left blank, then the entire document's source will be retrieved. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
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) |
| Name | Description |
|---|---|
| retry | A FlowFile is routed to this relationship if the document cannot be fetched but attempting the operation again may succeed. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation. |
| success | All FlowFiles that are read from Elasticsearch are routed to this relationship. |
| failure | All FlowFiles that cannot be read from Elasticsearch are routed to this relationship. Note that only incoming flow files will be routed to failure. |
| not found | A FlowFile is routed to this relationship if the specified document does not exist in the Elasticsearch cluster. Note that if the processor has no incoming connections, flow files may still be sent to this relationship based on the processor properties and the results of the fetch operation. |
| Name | Description |
|---|---|
| filename | The filename attribute is set to the document identifier |
| es.index | The Elasticsearch index containing the document |
| es.type | The Elasticsearch document type |