GetSFTP
描述:
从SFTP服务器获取文件并创建响应的数据流输出
标签:
sftp, get, retrieve, files, fetch, remote, ingest, source, input, 接收, 读取, 远程
参数:
如下列表中，必填参数则标识为加粗. 其他未加粗参数，则表示为可选参数。表中同时提到参数默认值设置, 参数还支持 表达式语言, 并且 如果将一个参数认定为"敏感", 表示是加密状态. 在输入一个敏感参数时, 确保 orchsym.properties 文件中存在属性设置 orchsym.sensitive.props.key.
| 名字 | 默认值 | 允许值列表 | 描述 |
|---|---|---|---|
| 主机 | 主机名或远程系统IP地址 支持表达式语言 (仅支持变量) | ||
| 端口号 | 22 | 远程主机获取数据的端口 支持表达式语言 (仅支持变量) | |
| 用户名 | 用户名 支持表达式语言 (仅支持变量) | ||
| 用户密码 | 用户密码 敏感状态 支持表达式语言 (仅支持变量) | ||
| 私钥路径 | 私钥文件的完全限定路径 支持表达式语言 (仅支持变量) | ||
| 私钥密码 | 私钥的密码 敏感状态 支持表达式语言 (仅支持变量) | ||
| 远程路径 | 远程系统上用于提取或推送文件的路径 支持表达式语言 (仅支持变量) | ||
| 文件过滤正则表达式 | 提供Java的正则表达式来过滤文件名，如果设置，仅名字匹配的文件将被读取 | ||
| 路径过滤正则表达式 | 当<遍历子目录>属性设置为true时，仅路径匹配表达式的子目录会被扫描处理 | ||
| 读取间隔 | 60 sec | 确定多个获取并创建新的文件之间的等待时间 | |
| 遍历子目录 | 不遍历 | - 遍历 - 不遍历 | 如果遍历，将遍历子目录并提取文件; 否则，将不会遍历子目录 |
| 忽略.开头文件 | 忽略 | - 忽略 - 不忽略 | 将决定是否忽略名称以点（“.”）开头的文件 |
| 删除原文件 | true | - true - false | 确定文件在成功传输后是否从远程系统中删除 |
| 连接超时 | 30 sec | 创建连接时超时之前等待的时间 | |
| 数据超时 | 30 sec | 在本地系统和远程系统之间传输文件时，此值指定在系统之间没有任何数据传输的情况下允许的时间 | |
| 主机密钥文件 | 如果提供，则给定文件将用作主机密钥; 否则，将不使用主机密钥文件 | ||
| 最大文件数 | 100 | 单个连接中要提取的最大文件数 | |
| 远程缓存分批数量 | 5000 | 该值指定在执行文件列表时在远程系统上的给定目录中查找的文件路径数。 通常不需要修改此值，但在对具有大量文件的远程系统进行轮询时，此值可能很重要。 将此值设置得太高会导致性能非常差，将其设置得太低会导致流量比正常情况慢。 | |
| 严格的主机秘钥验证 | 否 | - 是 - 否 | 指示是否应该严格执行主机密钥 |
| 超时是否发生活跃消息 | 是 | - 是 - 否 | 指示SSH连接超时时是否发送单个保持活跃消息 |
| 启用压缩 | 不启用 | - 启用 - 不启用 | 指示传输文件时是否应使用ZLIB压缩 |
| 使用自然顺序 | 不使用 | - 使用 - 不使用 | 如果使用，将按自然列出的顺序提取文件; 否则，不定义文件的提取顺序 |
| 代理配置 | 控制器服务API: ProxyConfigurationService 实现: StandardProxyConfigurationService | 提供代理配置服务，如果设置，将取代每个组件的代理设置。且支持 SOCKS 和HTTP + AuthN | |
| 代理类型 | DIRECT | - DIRECT - HTTP - SOCKS | 用于文件传输的代理类型 |
| 代理主机 | 代理主机名或IP地址 支持表达式语言 (仅支持变量) | ||
| 代理端口号 | 代理服务器的代理端口号 支持表达式语言 (仅支持变量) | ||
| Http代理用户名 | Http代理用户名 支持表达式语言 (仅支持变量) | ||
| Http代理用户密码 | Http代理用户密码 敏感状态 支持表达式语言 (仅支持变量) |
连线:
| 名字 | 描述 |
|---|---|
| success | 成功读取的数据流都将输出到此连线 |
读取属性:
未提供。
写入属性:
| 名字 | 描述 |
|---|---|
| filename | 文件名设置为远程服务器上文件的名称 |
| path | 该路径设置为远程服务器上文件目录的路径。 例如，如果<远程路径>属性设置为/tmp，则从/tmp中拾取的文件将path属性设置为/tmp。 如果<遍历子目录>属性设置为true并且从/tmp/abc/1/2/3中拾取文件，则path属性将设置为/tmp/abc/1/2/3 |
| file.lastModifiedTime | 上次修改源文件的日期和时间 |
| file.owner | 源文件的所有者ID（数字值） |
| file.group | 源文件的组ID（数字值） |
| file.permissions | 源文件的读/写/执行权限 |
| absolute.path | 获取文件的完整或绝对路径。 当前的“path”属性仍然被设置，但可能是相对路径 |
状态管理:
该组件不保存状态。
限制:
该组件没有限制
输入流要求:
组件禁止提供输入流。
系统资源考量:
未提供。