ElasticSearchLookupService

ElasticSearchLookupService 2.0.0

Bundle: org.apache.nifi | nifi-elasticsearch-client-service-nar
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: elasticsearch, enrich, lookup, record
Input Requirement
Supports Sensitive Dynamic Properties: false

Properties

Index
The name of the index to read from

Display Name

Index

Description

The name of the index to read from

API Name

el-lookup-index

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

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

Display Name

Type

Description

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

API Name

el-lookup-type

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Client Service
An ElasticSearch client service to use for running queries.

Display Name

Client Service

Description

An ElasticSearch client service to use for running queries.

API Name

el-rest-client-service

Service Interface

org.apache.nifi.elasticsearch.ElasticSearchClientService

Service Implementations

org.apache.nifi.elasticsearch.ElasticSearchClientServiceImpl

Expression Language Scope

Not Supported

Sensitive

false

Required

true
Schema Access Strategy
Specifies how to obtain the schema that is to be used for interpreting the data.
Display Name

Schema Access Strategy

Description

Specifies how to obtain the schema that is to be used for interpreting the data.

API Name

schema-access-strategy

Default Value

infer

Allowable Values
- Use 'Schema Name' Property
- Use 'Schema Text' Property
- Infer from Result
Expression Language Scope

Not Supported

Sensitive

false

Required

true
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.
Display Name

Schema Branch

Description

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.

API Name

schema-branch

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Name
Specifies the name of the schema to lookup in the Schema Registry property
Display Name

Schema Name

Description

Specifies the name of the schema to lookup in the Schema Registry property

API Name

schema-name

Default Value

${schema.name}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]
Schema Registry
Specifies the Controller Service to use for the Schema Registry
Display Name

Schema Registry

Description

Specifies the Controller Service to use for the Schema Registry

API Name

schema-registry

Service Interface

org.apache.nifi.schemaregistry.services.SchemaRegistry

Service Implementations

org.apache.nifi.aws.schemaregistry.AmazonGlueSchemaRegistry

org.apache.nifi.apicurio.schemaregistry.ApicurioSchemaRegistry

org.apache.nifi.schemaregistry.services.AvroSchemaRegistry

org.apache.nifi.confluent.schemaregistry.ConfluentSchemaRegistry

org.apache.nifi.db.schemaregistry.DatabaseTableSchemaRegistry

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-reference-reader, schema-name]
Schema Text
The text of an Avro-formatted Schema
Display Name

Schema Text

Description

The text of an Avro-formatted Schema

API Name

schema-text

Default Value

${avro.schema}

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-text-property]
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.
Display Name

Schema Version

Description

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.

API Name

schema-version

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

false

Dependencies
- Schema Access Strategy is set to any of [schema-name]

Dynamic Properties

A JSONPath expression
Retrieves an object using JSONPath from the result document and places it in the return Record at the specified Record Path.

Name

A JSONPath expression

Description

Retrieves an object using JSONPath from the result document and places it in the return Record at the specified Record Path.

Value

A Record Path expression

Expression Language Scope

NONE