ai.sftp

クライアントの作成

ai.sftp.createClient

createClient() メソッドで SFTP インスタンスを作成し、SFTP サーバーですべての操作を開始できます。この関数は、スクリプトに設定された SFTP 接続文字列の名前をパラメータとして取り、クライアント インスタンス オブジェクトを返します。

方法	パラメータ	戻り値の型	説明
createClient(sftpConnection)	sftpConnection : String SFTP 接続の名称	オブジェクト	SFTP クライアントの作成

使用方法

const client = ai.sftp.createClient('mySftpConnectionSetting');

基本的なクライアント操作

ファイルのダウンロード

ファイル リーダー方法

これらのメソッドは、DownloadFiles() メソッドから返されたリーダー オブジェクトで呼び出すことができます。

readLine()		String	ファイルを 1 行ごとに読み取ります
クリーンアップ()			ファイル リーダー オブジェクトが消費するシステム リソースを解放 FileReader は、クリーンアップ() メソッドの実行後に使用できません。 リソースはスクリプトの最後で自動的にクリーンアップされます。

例

//Pass the relative filepath and the name of your encryption setting
const reader = client.downloadEncryptedFile('./archive/datasample.csv.asc', 'mypgp');
let line = reader.readLine()
while(line !== null){
    //Process the line
    line = reader.readLine()
}

ファイルのアップロード

ファイル ライターの方法

ファイルのダウンロードから返されたリーダー オブジェクトに対して次のメソッドを呼び出すことができます。

writeLine(val)	val: 文字列 ファイルに書き込む内容		ファイルに 1 行ごとに内容を書き込みます。
クリーンアップ()			ファイル ライター オブジェクトが消費するシステム リソースを解放 クリーンアップ() メソッドの実行後にライターを使用することはできません。 リソースはスクリプトの最後で自動的にクリーンアップされます。

例

const client = ai.sftp.createClient('mySftpConnectionSetting');
​
//Invoke the File Writer method
const writer = ai.sftp.createFileWriter();
​
//Write content to the writer variable
writer.writeLine('Here is a line to upload');
client.uploadFile(writer, 'myFileToShare.txt');
writer.cleanUp();

SFTP に対応した AWS Transfer に関する注意事項

CreateDirectory
AWS S3 では、新しいディレクトリのパスを指定できます。例: client.createDirectory('./parent/子');によって親ディレクトリが作成されます。ただし、親ディレクトリがすでに存在する場合に子ディレクトリを作成しようとすると、例外が送られます。