ElasticSearchLookupService

Description:

Lookup a record from Elasticsearch Server associated with the specified document ID. The coordinates that are passed to the lookup must contain the key 'id'.

Additional Details...

Tags:

lookup, enrich, record, elasticsearch

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
Schema Access Strategy	schema-access-strategy	Infer from Result	Use 'Schema Name' Property Use 'Schema Text' Property Infer from Result	Specifies how to obtain the schema that is to be used for interpreting the data.
Schema Registry	schema-registry		Controller Service API: SchemaRegistry Implementations: DatabaseTableSchemaRegistry HortonworksSchemaRegistry ConfluentSchemaRegistry AvroSchemaRegistry AmazonGlueSchemaRegistry	Specifies the Controller Service to use for the Schema Registry This Property is only considered if the [Schema Access Strategy] Property is set to one of the following values: [Use 'Schema Name' Property]
Schema Name	schema-name	${schema.name}		Specifies the name of the schema to lookup in the Schema Registry property Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
Schema Version	schema-version			Specifies the version of the schema to lookup in the Schema Registry. If not specified then the latest version of the schema will be retrieved. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
Schema Branch	schema-branch			Specifies the name of the branch to use when looking up the schema in the Schema Registry property. If the chosen Schema Registry does not support branching, this value will be ignored. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Name' Property".
Schema Text	schema-text	${avro.schema}		The text of an Avro-formatted Schema Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Schema Access Strategy] Property has a value of "Use 'Schema Text' Property".
Client Service	el-rest-client-service		Controller Service API: ElasticSearchClientService Implementation: ElasticSearchClientServiceImpl	An ElasticSearch client service to use for running queries.
Index	el-lookup-index			The name of the index to read from Supports Expression Language: true (will be evaluated using variable registry only)
Type	el-lookup-type			The type of this document (used by Elasticsearch for indexing and searching) Supports Expression Language: true (will be evaluated using variable registry only)

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 JSONPath expression	A Record Path expression	Retrieves an object using JSONPath from the result document and places it in the return Record at the specified Record Path. Supports Expression Language: false

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.