Apache NiFi 2.x:FetchFTP 2.2.0
包
org.apache.nifi | nifi-standard-nar
描述
从远程FTP服务器获取文件内容，并使用远程文件的内容覆盖传入FlowFile的内容。
标签
获取、文件、FTP、获取、摄取、输入、远程、检索、源
输入要求
必填
支持敏感动态属性
否
属性
完成策略
指定将服务器上的原始文件拉入NiFi后对其执行的操作。如果完成策略失败，将记录一条警告，但数据仍会传输。
显示名称 | 完成策略 |
描述 | 指定将服务器上的原始文件拉入NiFi后对其执行的操作。如果完成策略失败，将记录一条警告，但数据仍会传输。 |
API名称 | Completion Strategy |
默认值 | 无 |
允许值 | 无 |
表达式语言作用域
不支持
敏感
否
必填
是
连接模式
FTP连接模式。
显示名称 | 连接模式 |
描述 | FTP连接模式 |
API名称 | Connection Mode |
默认值 | 被动模式 |
允许值 | 主动模式 |
表达式语言作用域
不支持
敏感
否
必填
否
连接超时时间
创建连接时等待的超时时间。
显示名称 | 连接超时时间 |
描述 | 创建连接时等待的超时时间。 |
API名称 | Connection Timeout |
默认值 | 30秒 |
表达式语言作用域 | 不支持 |
敏感 | 否 |
必填 | 是 |
创建目录
当“完成策略”为“移动文件”时使用。指定如果远程目录不存在是否应创建它。
显示名称 | 创建目录 |
描述 | 当“完成策略”为“移动文件”时使用。指定如果远程目录不存在是否应创建它。 |
API名称 | Create Directory |
默认值 | 否 |
允许值 | 是 |
表达式语言作用域
不支持
敏感
否
必填
否
数据传输超时时间
在本地和远程系统之间传输文件时，此值指定在系统之间没有任何数据传输的情况下允许经过的时间。
显示名称 | 数据传输超时时间 |
描述 | 在本地和远程系统之间传输文件时，此值指定在系统之间没有任何数据传输的情况下允许经过的时间。 |
API名称 | Data Timeout |
默认值 | 30秒 |
表达式语言作用域 | 不支持 |
敏感 | 否 |
必填 | 是 |
文件未找到时的日志级别
处理器触发时，如果文件不存在，使用的日志级别。
显示名称 | 文件未找到时的日志级别 |
描述 | 处理器触发时，如果文件不存在，使用的日志级别。 |
API名称 | fetchfiletransfer-notfound-loglevel |
默认值 | 错误 |
允许值 | 追踪 |
表达式语言作用域
不支持
敏感
否
必填
是
使用UTF-8编码
指示客户端在处理文件和文件名时使用UTF-8编码。如果设置为“是”，服务器也必须支持UTF-8编码。
显示名称 | 使用UTF-8编码 |
描述 | 指示客户端在处理文件和文件名时使用UTF-8编码。如果设置为“是”，服务器也必须支持UTF-8编码。 |
API名称 | ftp-use-utf8 |
默认值 | 否 |
允许值 | 是 |
表达式语言作用域
不支持
敏感
否
必填
是
主机名
要从中获取数据的主机的完全限定主机名或IP地址。
显示名称 | 主机名 |
描述 | 要从中获取数据的主机的完全限定主机名或IP地址。 |
API名称 | Hostname |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 否 |
必填 | 是 |
内部缓冲区大小
设置缓冲数据流的内部缓冲区大小。
显示名称 | 内部缓冲区大小 |
描述 | 设置缓冲数据流的内部缓冲区大小。 |
API名称 | Internal Buffer Size |
默认值 | 16KB |
表达式语言作用域 | 不支持 |
敏感 | 否 |
必填 | 否 |
移动目标目录
将原始文件摄入NiFi后，要将其移动到的远程服务器上的目录。除非“完成策略”设置为“移动文件”，否则此属性将被忽略。如果“创建目录”被禁用，指定的目录必须在远程系统上已经存在，否则重命名将失败。
显示名称 | 移动目标目录 |
描述 | 将原始文件摄入NiFi后，要将其移动到的远程服务器上的目录。除非“完成策略”设置为“移动文件”，否则此属性将被忽略。如果“创建目录”被禁用，指定的目录必须在远程系统上已经存在，否则重命名将失败。 |
API名称 | Move Destination Directory |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 否 |
必填 | 否 |
密码
用户账户的密码。
显示名称 | 密码 |
描述 | 用户账户的密码。 |
API名称 | Password |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 是 |
必填 | 否 |
端口
要连接到的远程主机上用于获取数据的端口。
显示名称 | 端口 |
描述 | 要连接到的远程主机上用于获取数据的端口。 |
API名称 | Port |
默认值 | 21 |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 否 |
必填 | 是 |
代理配置服务
指定用于代理网络请求的代理配置控制器服务。支持的代理：SOCKS + 身份验证、HTTP + 身份验证。
显示名称 | 代理配置服务 |
描述 | 指定用于代理网络请求的代理配置控制器服务。支持的代理：SOCKS + 身份验证、HTTP + 身份验证 |
API名称 | proxy-configuration-service |
服务接口 | org.apache.nifi.proxy.ProxyConfigurationService |
服务实现 | org.apache.nifi.proxy.StandardProxyConfigurationService |
表达式语言作用域 | 不支持 |
敏感 | 否 |
必填 | 否 |
远程文件
远程系统上的完全限定文件名。
显示名称 | 远程文件 |
描述 | 远程系统上的完全限定文件名。 |
API名称 | Remote File |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 否 |
必填 | 是 |
传输模式
FTP传输模式。
显示名称 | 传输模式 |
描述 | FTP传输模式 |
API名称 | Transfer Mode |
默认值 | 二进制 |
允许值 | 二进制 |
表达式语言作用域
不支持
敏感
否
必填
否
使用压缩
指示在传输文件时是否应使用ZLIB压缩。
显示名称 | 使用压缩 |
描述 | 指示在传输文件时是否应使用ZLIB压缩。 |
API名称 | Use Compression |
默认值 | 否 |
允许值 | 是 |
表达式语言作用域
不支持
敏感
否
必填
是
用户名
用户名。
显示名称 | 用户名 |
描述 | 用户名 |
API名称 | Username |
表达式语言作用域 | 环境变量和FlowFile属性 |
敏感 | 否 |
必填 | 是 |
关系
名称 | 描述 |
not.found | 从远程服务器收到“未找到”消息的任何FlowFile都将被传输到此关系。 |
comms.failure | 由于通信故障无法从远程服务器获取的任何FlowFile都将被传输到此关系。 |
success | 收到的所有FlowFile都将被路由到success。 |
permission.denied | 由于权限不足无法从远程服务器获取的任何FlowFile都将被传输到此关系。 |
写入属性
名称 | 描述 |
ftp.remote.host | 从中提取文件的主机名或IP地址 |
ftp.remote.port | 用于与远程FTP服务器通信的端口 |
ftp.remote.filename | 提取的远程文件的名称 |
filename | 文件名更新为指向远程文件的文件名 |
path | 如果远程文件包含目录名，则该目录名将使用“path”属性添加到FlowFile中 |
fetch.failure.reason | 路由到任何失败关系时应用的失败关系名称 |
涉及其他组件的用例
检索FTP服务器目录中的所有文件。
另请参阅
- org.apache.nifi.processors.standard.GetFTP
- org.apache.nifi.processors.standard.GetSFTP
- org.apache.nifi.processors.standard.PutFTP
- org.apache.nifi.processors.standard.PutSFTP
