| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ElasticSearchClientServiceImpl</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ElasticSearchClientServiceImpl</h1><h2>Description: </h2><p>No description provided.</p><h3>Tags: </h3><p>No tags provided.</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>HTTP Hosts</strong></td><td>el-cs-http-hosts</td><td></td><td id="allowable-values"></td><td id="description">A comma-separated list of HTTP hosts that host Elasticsearch query nodes.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Authorization Scheme</strong></td><td>authorization-scheme</td><td id="default-value">Basic</td><td id="allowable-values"><ul><li>None <img src="../../../../../html/images/iconInfo.png" alt="No authorization scheme." title="No authorization scheme."></img></li><li>PKI <img src="../../../../../html/images/iconInfo.png" alt="Mutual TLS with PKI certificate authorization scheme." title="Mutual TLS with PKI certificate authorization scheme."></img></li><li>Basic <img src="../../../../../html/images/iconInfo.png" alt="Basic authorization scheme." title="Basic authorization scheme."></img></li><li>API Key <img src="../../../../../html/images/iconInfo.png" alt="API key authorization scheme." title="API key authorization scheme."></img></li></ul></td><td id="description">Authorization Scheme used for optional authentication to Elasticsearch.</td></tr><tr><td id="name">Username</td><td>el-cs-username</td><td></td><td id="allowable-values"></td><td id="description">The username to use with XPack security.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Authorization Scheme] Property has a value of "Basic".</strong></td></tr><tr><td id="name">Password</td><td>el-cs-password</td><td></td><td id="allowable-values"></td><td id="description">The password to use with XPack security.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Authorization Scheme] Property has a value of "Basic".</strong></td></tr><tr><td id="name">API Key ID</td><td>api-key-id</td><td></td><td id="allowable-values"></td><td id="description">Unique identifier of the API key.<br/><br/><strong>This Property is only considered if </strong><strong>the [Authorization Scheme] Property has a value of "API Key".</strong></td></tr><tr><td id="name">API Key</td><td>api-key</td><td></td><td id="allowable-values"></td><td id="description">Encoded API key.<br/><strong>Sensitive Property: true</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Authorization Scheme] Property has a value of "API Key".</strong></td></tr><tr><td id="name">SSL Context Service</td><td>el-cs-ssl-context-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">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.</td></tr><tr><td id="name">Proxy Configuration Service</td><td>proxy-configuration-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.19.1/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP</td></tr><tr><td id="name"><strong>Connect timeout</strong></td><td>el-cs-connect-timeout</td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when trying to connect.</td></tr><tr><td id="name"><strong>Read timeout</strong></td><td>el-cs-socket-timeout</td><td id="default-value">60000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when waiting for a response.</td></tr><tr><td id="name"><strong>Retry timeout</strong></td><td>el-cs-retry-timeout</td><td id="default-value">60000</td><td id="allowable-values"></td><td id="description">Controls the amount of time, in milliseconds, before a timeout occurs when retrying the operation.</td></tr><tr><td id="name"><strong>Charset</strong></td><td>el-cs-charset</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The charset to use for interpreting the response from Elasticsearch.</td></tr><tr><td id="name"><strong>Suppress Null/Empty Values</strong></td><td>el-cs-suppress-nulls</td><td id="default-value">Always Suppress</td><td id="allowable-values"><ul><li>Never Suppress <img src="../../../../../html/images/iconInfo.png" alt="Fields that are missing (present in the schema but not in the record), or that have a value of null/empty, will be written out as a null/empty value" title="Fields that are missing (present in the schema but not in the record), or that have a value of null/empty, will be written out as a null/empty value"></img></li><li>Always Suppress <img src="../../../../../html/images/iconInfo.png" alt="Fields that are missing (present in the schema but not in the record), or that have a value of null/empty, will not be written out" title="Fields that are missing (present in the schema but not in the record), or that have a value of null/empty, will not be written out"></img></li></ul></td><td id="description">Specifies how the writer should handle null and empty fields (including objects and arrays)</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> |