GetElasticsearch

GetElasticsearch Processor

类型全限定名：cn.org.acal.lynxus.processors.elasticsearch.GetElasticsearch

所属 Bundle：cn.org.acal.lynxus:lynxus-elasticsearch-restapi-nar:2.11.8

Elasticsearch 获取处理器使用官方 Elastic REST 客户端库通过 _id 从 Elasticsearch 获取单个文档。请注意，在写入 FlowFile 进行传输之前，文档的完整正文将被读入内存。

下表中，加粗的属性为必填项；其余为可选项。表格同时标注默认值、是否支持表达式语言，以及是否为敏感属性（值会被加密）。

名称	默认值	可选值	描述
Document Id			要检索的文档的 _id。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Index			要使用的索引的名称。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Type			该文档的类型（Elasticsearch 用于索引和搜索）。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Destination	`flowfile-content`	FlowFile Content — 将检索到的文档作为 FlowFile 内容输出。 FlowFile Attribute — 将检索到的文档作为由 Attribute Name 指定的 FlowFile 属性输出。	指示检索到的文档是否写入 FlowFile 内容或 FlowFile 属性。
Attribute Name	`elasticsearch.doc`		用于检索的文档输出的 FlowFile 属性的名称。支持表达式语言：是（使用 FlowFile 属性与环境/系统变量求值）
Client Service		控制器服务 API： `ElasticSearchClientService` cn.org.acal.lynxus-lynxus-elasticsearch-client-service-api-nar-2.11.8	用于运行查询的 Elasticsearch 客户端服务。

动态属性允许用户自定义属性的名称与值。

名称	值	描述
HTTP 请求头的名称	用于检索 HTTP 请求头值的 Record Path 表达式	前缀：HEADER: - 将指定的属性名称/值作为 HTTP 请求头添加到 Elasticsearch 请求中。如果 Record Path 表达式结果为 null 或空值，则将省略该 HTTP 请求头。
要添加的 URL 查询参数的名称	URL 查询参数的值	在用于处理的 Elasticsearch URL 中将指定的属性名称/值添加为查询参数。

名称	描述	自动终止
`document`	获取的文档将路由到此关系。	否
`failure`	所有因与服务器可用性无关的原因而失败的 FlowFile 都会转至此关系。	否
`not_found`	如果指定的文档在 Elasticsearch 集群中不存在，则 FlowFile 将路由到此关系。	否
`retry`	由于服务器/集群可用性而失败的所有 FlowFile 都会转至此关系。	否

名称	描述
`filename`	filename 属性被设置为文档标识符
`elasticsearch.index`	包含文档的 Elasticsearch 索引
`elasticsearch.type`	Elasticsearch 文档类型
`elasticsearch.get.error`	如果获取文档时出现错误，Elasticsearch 会提供错误消息。

该组件不存储状态。

该组件不受限。

该组件允许有传入连接。