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’.

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 Expression Language Guide.

Name

Default Value

Allowable Values

Description

Schema Access Strategy

infer
  • 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

Controller Service API: 


SchemaRegistry

Implementations: 


ConfluentSchemaRegistry
AvroSchemaRegistry
HortonworksSchemaRegistry
Specifies the Controller Service to use for the Schema Registry
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)


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)


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)


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)


Client Service

Controller Service API: 


ElasticSearchClientService

Implementation: 


ElasticSearchClientServiceImpl
An ElasticSearch client service to use for running queries.

Index

The name of the index to read from

Supports Expression Language: true (will be evaluated using variable registry only)


Type The type of this document (used by Elasticsearch for indexing and searching)

Supports Expression Language: true (will be evaluated using variable registry only)


State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.