ElasticSearchClientServiceImpl

Description:

No description provided.

Tags:

No tags provided.

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
HTTP Hostsel-cs-http-hostsA comma-separated list of HTTP hosts that host Elasticsearch query nodes.
Supports Expression Language: true (will be evaluated using variable registry only)
Authorization Schemeauthorization-schemeBasic
  • None No authorization scheme.
  • PKI Mutual TLS with PKI certificate authorization scheme.
  • Basic Basic authorization scheme.
  • API Key API key authorization scheme.
Authorization Scheme used for optional authentication to Elasticsearch.
Usernameel-cs-usernameThe username to use with XPack security.
Supports Expression Language: true (will be evaluated using variable registry only)

This Property is only considered if the [Authorization Scheme] Property has a value of "Basic".
Passwordel-cs-passwordThe password to use with XPack security.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)

This Property is only considered if the [Authorization Scheme] Property has a value of "Basic".
API Key IDapi-key-idUnique identifier of the API key.

This Property is only considered if the [Authorization Scheme] Property has a value of "API Key".
API Keyapi-keyEncoded API key.
Sensitive Property: true

This Property is only considered if the [Authorization Scheme] Property has a value of "API Key".
SSL Context Serviceel-cs-ssl-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.
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
ProxyConfigurationService
Implementation: StandardProxyConfigurationService
Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP
Connect timeoutel-cs-connect-timeout5000Controls the amount of time, in milliseconds, before a timeout occurs when trying to connect.
Read timeoutel-cs-socket-timeout60000Controls the amount of time, in milliseconds, before a timeout occurs when waiting for a response.
Retry timeoutel-cs-retry-timeout60000Controls the amount of time, in milliseconds, before a timeout occurs when retrying the operation.
Charsetel-cs-charsetUTF-8The charset to use for interpreting the response from Elasticsearch.
Suppress Null/Empty Valuesel-cs-suppress-nullsAlways Suppress
  • Never Suppress 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
  • Always Suppress 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
Specifies how the writer should handle null and empty fields (including objects and arrays)

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.