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

オペレーション名

ファイル/フォルダ削除

機能概要

Amazon S3上にあるファイル/フォルダを削除します。

データモデル

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

プロパティ

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

スキーマ

入力スキーマ

ありません。

出力スキーマ

ファイル削除の場合

<?xml version="1.0"?>
<server>
  <bucket name="" status="" >
    <file name="" remotepath="" status="" type="" />
  </bucket>
</server>
要素名 属性名 説明 備考
server -    
bucket - 取得したBucketごとに出現します。  
name 取得したBucketの名前を出力します。  
status 取得したBucketの状態を出力します。
  • Exist:Bucketが存在している状態です。
  • ErrorBucketNotFound:指定した[Bucket]がAmazon S3上に存在しない状態です。指定したBucket名が誤っている可能性があります。
  • Error:エラーが発生したため、Bucketの存在を確認できなかった状態です。
  
file - 削除したファイル/フォルダごとに出現します。  
name 削除したファイル/フォルダの名前を出力します。
  • statusが「ErrorRemoteFolderNotFound」の場合は値が空白になります。
  • [フォルダを削除する]が[チェックあり]の場合は値が空白になります。
remotepath 削除したファイル/フォルダのAmazon S3上のファイルパスを出力します。  
status 削除したファイル/フォルダの状態を出力します。
  • Deleted:ファイル/フォルダが正常に削除された状態です。
  • ErrorRemoteFolderNotFound:Amazon S3上に、指定した[フォルダパス]が存在しない、またはファイルを指定した状態です。
  • ErrorRemoteFileNotFound:Amazon S3上で、指定した[フォルダパス]内に指定したファイル/フォルダが存在しない状態です。
  • Error:エラーが発生したため、ファイル/フォルダの削除ができなかった状態です。
  
type 削除したファイル/フォルダの種別を出力します。
  • File:ファイル
  • Folder:フォルダ
  

Bucket削除の場合

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

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」
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

ありません。

主な例外

例外名 原因 対策
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[]		 [接続先]が指定されていません。 [接続先]を指定してください。
ResourceNotFoundException
リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]		 [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
InvalidPropertyConfigurationException
ファイル/フォルダ名に「/」が含まれています。		 [ファイル/フォルダ名]に「/」が含まれています。 [ファイル/フォルダ名]には、「/」を含まないファイル/フォルダ名を指定してください。
java.lang.UnsupportedOperationException
ルートフォルダを削除することはできません。		 ルートフォルダを削除しようとしています。 [フォルダを削除する]が[チェックあり]の場合は、[フォルダパス]にルートフォルダ以外を指定してください。
Status Code: 403, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: InvalidAccessKeyId, AWS Error Message: The AWS Access Key Id you provided does not exist in our records., S3 Extended Request ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX [接続先]で指定したグローバルリソースの[Access Key ID]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。
Status Code: 403, AWS Request ID: XXXXXXXXXXXXXXXX, AWS Error Code: SignatureDoesNotMatch, AWS Error Message: The request signature we calculated does not match the signature you provided. Check your key and signing method., S3 Extended Request ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX [接続先]で指定したグローバルリソースの[Secret Access Key]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。
com.amazonaws.SdkClientException
Unable to execute HTTP request: <endpoint>		 [接続先]で指定したグローバルリソースの[Endpoint]に誤りがあります。 [接続先]で指定したグローバルリソースの設定を確認してください。

注意事項