ListFTP 2025.10.2.19¶
バンドル¶
org.apache.nifi | nifi-standard-nar
説明¶
FTP サーバーに存在するファイルのリストをパフォーマンスします。リモート・サーバー上で見つかったファイルごとに、ファイル名属性にリモート・サーバー上のファイル名をセットした新しい FlowFile が作成されます。これは、 FetchFTP と組み合わせて使用することで、これらのファイルを取得することができます。
入力要件¶
FORBIDDEN
機密動的プロパティをサポート¶
false
プロパティ¶
プロパティ |
説明 |
|---|---|
接続モード |
FTP 接続モード |
接続タイムアウト |
接続作成中にタイムアウトするまでの待機時間 |
データタイムアウト |
ローカルとリモートのシステム間でファイルを転送する場合、この値はシステム間でデータが転送されずに経過する時間を指定します。 |
ファイルフィルター正規表現 |
フィルターが指定された場合、そのJava正規表現にマッチする名前のファイルのみが取得されます。フィルターが提供されている場合、フェッチされる正規表現に名前が一致するファイルだけです。 |
ホスト名 |
リモートシステムの完全修飾ホスト名または IP アドレス。 |
ドット付きファイルの無視 |
true の場合、ファイル名がドット (".") で始まるファイルは無視されます。 |
内部バッファサイズ |
バッファリングされたデータストリームの内部バッファサイズのセット |
パスワード |
ユーザーアカウントのパスワード |
パスフィルター正規表現 |
再帰検索が true の場合、与えられた正規表現にパスが一致する サブディレクトリのみがスキャンされます。 |
ポート |
データを取得するためにリモートホストで接続するポート。 |
リモートパス |
ファイルをプルまたはプッシュするリモートシステム上のパス。 |
リモート ポール バッチ サイズ |
The value specifies how many file paths to find in a given directory on the remote system when doing a file listing. This value in general should not need to be modified but when polling against a remote system with a tremendous number of files this value can be critical. Setting this value too high can result very poor performance and setting it too low can cause the flow to be slower than normal. |
再帰検索 |
trueの場合、任意にネストされたサブディレクトリからファイルを取り出します。それ以外の場合、サブディレクトリをトラバースしません。 |
転送モード |
FTP 転送モード |
ユーザー名 |
ユーザー名 |
et-initial-listing-target |
Specify how initial listing should be handled. Used by 'Tracking Entities'strategy. |
et-state-cache |
Listed entities are stored in the specified cache storage so that this processor can resume listing across NiFi restart or in case of primary node change. 'Tracking Entities'strategy require tracking information of all listed entities within the last 'Tracking Time Window'. To support large number of entities, the strategy uses DistributedMapCache instead of managed state. Cache key format is 'ListedEntities::{processorId}(::{nodeId})'. If it tracks per node listed entities, then the optional '::{nodeId}' part is added to manage state separately. E.g. cluster wide cache key ='ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b', per node cache key ='ListedEntities::8dda2321-0164-1000-50fa-3042fe7d6a7b::nifi-node3' The stored cache content is Gzipped JSON string. The cache key will be deleted when target listing configuration is changed. Used by 'Tracking Entities'strategy. |
et-time-window |
Specify how long this processor should track already-listed entities. 'Tracking Entities'strategy can pick any entity whose timestamp is inside the specified time window. For example, if set to '30 minutes', any entity having timestamp in recent 30 minutes will be the listing target when this processor runs. A listed entity is considered 'new/updated' and a FlowFile is emitted if one of following condition meets: 1. does not exist in the already-listed entities, 2. has newer timestamp than the cached entity, 3. has different size than the cached entity. If a cached entity 's timestamp becomes older than specified time window, that entity will be removed from the cached already-listed entities. Used by'Tracking Entities'strategy. |
follow-symlink |
trueの場合、シンボリックファイルとネストされたシンボリックサブディレクトリも読み込みます。それ以外の場合は、シンボリックファイルを読み込まず、シンボリック リンク サブディレクトリをトラバースしません。 |
ftp-use-utf8 |
ファイルやファイル名を処理するときに UTF-8 エンコードを使うようにクライアントに指示します。trueにセットすると、サーバは UTF-8エンコーディングもサポートしなければなりません。 |
listing-strategy |
新規/更新エンティティの判定方法を指定します。詳しくは各戦略の説明をご覧ください。 |
proxy-configuration-service |
ネットワークリクエストをプロキシするプロキシ構成Controller Serviceを指定します。 |
record-writer |
リストの作成に使用するRecord Writerを指定します。指定しない場合は、リストされたエンティティごとに FlowFile が1つ作成されます。Record Writerを指定すると、個々の FlowFiles に属性を追加する代わりに、すべてのエンティティが単一の FlowFile に書き込まれます。 |
target-system-timestamp-precision |
ターゲットシステムでのタイムスタンプ精度を指定します。このプロセッサーは、エンティティのタイムスタンプを使用してリストを決定するため、正しいタイムスタンプ精度を使用することが重要です。 |
状態管理¶
スコープ |
説明 |
|---|---|
CLUSTER |
ファイルのリストをパフォーマンスした後、最も新しいファイルのタイムスタンプが保存されます。これにより、次回 Processor を実行したときに、この日付以降に追加または変更されたファイルのみがリストされます。状態はクラスタリングに保存され、このプロセッサーがプライマリ・ノードで実行されます。新しいプライマリ・ノードが選択された場合、新しいノードが前のプライマリ・ノードによってリストされたデータを複製することはありません。 |
リレーションシップ¶
名前 |
説明 |
|---|---|
success |
受信したすべての FlowFiles は成功にルーティングされます。 |
属性の書き込み¶
名前 |
説明 |
|---|---|
ftp.remote.host |
FTP サーバーのホスト名。 |
ftp.remote.port |
FTP サーバーで接続されたポート。 |
ftp.listing.user |
FTP リストを実行したユーザーのユーザー名。 |
file.owner |
ソース・ファイルの数値所有者ID |
file.group |
ソースファイルの数値グループID |
file.permissions |
ソースファイルの読み取り/書き込み/実行パーミッション |
file.size |
ソースファイルのバイト数 |
file.lastModifiedTime |
ファイルシステム内のファイルが最後に変更されたときのタイムスタンプを 'yyyy-MM-dd'T'HH:mm:ssZ' として返します。 |
filename |
FTP サーバー上のファイル名 |
path |
ファイルが取り出された FTP Server 上のディレクトリの完全修飾名。 |