ファイル/フォルダ削除処理

オペレーション名

ファイル/フォルダ削除

機能概要

ニフティクラウドストレージ上にあるファイル/フォルダを削除します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  
バケット名 必須 使用可 バケットを指定します。
  • [バケット名]に大量のファイルが存在するバケットを指定した場合、[フォルダパス]のリストの更新に時間がかかることがあります。
    回避方法については、「注意事項」を参照してください。
バケットを削除する 省略可 使用不可 バケットを削除するかどうかを選択します。
  • [チェックあり]:
    バケットを削除します。
  • [チェックなし]:(デフォルト)
    ファイル/フォルダを削除します。
  
フォルダパス 必須 使用可 ニフティクラウドストレージのフォルダパスを入力します。
  • フォルダパスはニフティクラウドストレージの絶対パスで指定してください。
  • パス区切り文字「/」以外のDataSpiderファイルシステムの使用禁止文字は使用できません。
  • [バケットを削除する]にチェックを入れた場合、無効になります。
フォルダを削除する 省略可 使用不可 フォルダを削除するかどうかを選択します。
  • [チェックあり]:
    フォルダを削除します。
  • [チェックなし]:(デフォルト)
    ファイルを削除します。
  
ファイル/フォルダ名 必須 使用可 ファイル/フォルダを指定します。
  • [バケットを削除する]および[フォルダを削除する]にチェックを入れた場合、無効になります。
  • ワイルドカード(「*」および「?」)が使用できます。
  • 「/」を含めることはできません。
再帰的に処理する 省略可 使用不可 指定したフォルダについて、再帰的にファイル/フォルダを削除するかどうかを選択します。
  • [チェックあり]:
    指定したフォルダにフォルダが含まれる場合、再帰的にファイル/フォルダを削除します。
  • [チェックなし]:(デフォルト)
    指定したフォルダ内のファイルのみ削除します。
  
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
  
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

入力スキーマ

ありません。

出力スキーマ

ファイル削除の場合

<?xml version="1.0"?>
<server>
  <bucket errorcode="" name="" status="" >
    <file errorcode="" name="" remotepath="" status="" type="" />
  </bucket>
</server>
要素名 属性名 説明 備考
server -    
bucket - 取得したバケットごとに出現します。  
errorcode バケット取得時にニフティクラウドストレージでエラーが発生した場合、ニフティクラウドストレージで定義されているAPIエラーコードを出力します。
  • ニフティクラウドストレージでエラーが発生しない場合空白になります。
  • ニフティクラウドストレージで定義されているAPIエラーコードについては、(http://cloud.nifty.com/api/storage/errorcode.htm)を参照してください。
name 取得したバケットの名前を出力します。  
status 取得したバケットの状態を出力します。
  • Exist:バケットが存在している状態です。
  • ErrorBucketNotFound:指定した[バケット]がニフティクラウドストレージ上に存在しない状態です。指定したバケット名が誤っている可能性があります。
  • Error:エラーが発生したため、バケットの存在を確認できなかった状態です。
  
file - 削除したファイル/フォルダごとに出現します。  
errorcode ファイル/フォルダ削除時にニフティクラウドストレージでエラーが発生した場合、ニフティクラウドストレージで定義されているAPIエラーコードを出力します。
  • ニフティクラウドストレージでエラーが発生しない場合空白になります。
  • ニフティクラウドストレージで定義されているAPIエラーコードについては、(http://cloud.nifty.com/api/storage/errorcode.htm)を参照してください。
name 削除したファイル/フォルダの名前を出力します。
  • statusが「ErrorRemoteFolderNotFound」の場合は値が空白になります。
  • [フォルダを削除する]が[チェックあり]の場合は値が空白になります。
remotepath 削除したファイル/フォルダのニフティクラウドストレージ上のファイルパスを出力します。  
status 削除したファイル/フォルダの状態を出力します。
  • Deleted:ファイル/フォルダが正常に削除された状態です。
  • ErrorRemoteFolderNotFound:ニフティクラウドストレージ上に、指定した[フォルダパス]が存在しない、またはファイルを指定した状態です。
  • ErrorRemoteFileNotFound:ニフティクラウドストレージ上で、指定した[フォルダパス]内に指定したファイル/フォルダが存在しない状態です。
  • Error:エラーが発生したため、ファイル/フォルダの削除ができなかった状態です。
  
type 削除したファイル/フォルダの種別を出力します。
  • File:ファイル
  • Folder:フォルダ
  

バケット削除の場合

<?xml version="1.0"?>
<server>
  <bucket name="" status="" />
</server>
要素名 属性名 説明 備考
server -    
bucket - 取得したバケットごとに出現します。  
name 取得したバケットの名前を出力します。  
status 取得したバケットの状態を出力します。
  • Deleted:バケットが正常に削除された状態です。
  • ErrorBucketNotFound:指定した[バケット]がニフティクラウドストレージ上に存在しない状態です。指定したバケット名が誤っている可能性があります。
  • Error:エラーが発生したため、バケットを削除できなかった状態です。
  

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名 説明 備考
count 削除したフォルダおよびファイルの数が格納されます。
  • デフォルト値はnullです。
  • 「folder_count」と「file_count」の合計です。
folder_count 削除したフォルダの数が格納されます。
  • デフォルト値はnullです。
file_count 削除したファイルの数が格納されます。
  • デフォルト値はnullです。
message_category エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。
  • デフォルト値はnullです。
message_code エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。
  • デフォルト値はnullです。
message_level エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。
  • デフォルト値はnullです。
error_type エラー発生時、発生したエラーの種類が格納されます。
  • デフォルト値はnullです。
  • エラーの種類は、以下のような形式となります。
    例:「java.io.FileNotFoundException」
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

ありません。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
InvalidPropertyConfigurationException
ファイル/フォルダ名に「/」が含まれています。		 [ファイル/フォルダ名]に「/」が含まれています。 [ファイル/フォルダ名]には、「/」を含まないファイル/フォルダ名を指定してください。
java.lang.UnsupportedOperationException
ルートフォルダを削除することはできません。		 ルートフォルダを削除しようとしています。 [フォルダを削除する]が[チェックあり]の場合は、[フォルダパス]にルートフォルダ以外を指定してください。
com.nifty.cloud.ncs.service.StorageException
The Access Key Id you provided does not exist in our records. 		[接続先]で指定したグローバルリソースの[AccessKey]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。
com.nifty.cloud.ncs.service.StorageException
The request signature we calculated does not match the signature you provided. Check your AWS Secret Access Key and signing method. For more information, see REST Authentication and SOAP Authentication for details.		 [接続先]で指定したグローバルリソースの[SecretAccessKey]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。
com.nifty.cloud.ncs.NiftyCloudClientException
Failed to execute HTTP request: Connect to ncss.nifty.com/ncss.nifty.com/xxx.xxx.xxx.xxx timed out		 [接続先]で指定したグローバルリソースの[タイムアウト]の間に、ニフティクラウドストレージとの接続が確認できませんでした。 [接続先]で指定したグローバルリソースの設定を確認してください。
com.nifty.cloud.ncs.NiftyCloudClientException
Failed to execute HTTP request: peer not authenticated		 [接続先]で指定したグローバルリソースの[タイムアウト]の間に、ニフティクラウドストレージの認証が確認できませんでした。 [接続先]で指定したグローバルリソースの設定を確認してください。

注意事項