Soracom

Users

ドキュメント
Home ドキュメント SORACOM Flux (Public beta) イベントソースリファレンス

SORACOM Harvest Files イベントソース

「新しいチャネルを作成」画面でイベントソースとして「SORACOM Harvest Files」を選択すると、SORACOM Harvest Files にファイルをアップロード (保存、更新) したり削除したりしたときに、Flux アプリが起動します。

[イベントソース設定]

イベントソースに連結したチャネルにメッセージが送信される条件を設定します。

項目説明
[有効]この条件を有効化する場合は、「有効」にします。
[ファイルパス (前方一致)]Harvest Files のファイルパスを入力します。ここで指定したパスと前方一致したファイルがイベントの対象です。
[イベントタイプ]

ファイルの変化の種類を選択します。ここでチェックを入れたイベントが検知されたときにメッセージが送信されます。

  • [ファイル作成]: ファイルが新規にアップロードされました。
  • [ファイル更新]: 既存のファイルと同名のファイルがアップロードされました。
  • [ファイル削除]: ファイルが削除されました。

SORACOM Harvest Files イベントソースを利用したチャネルは、オペレーターごとに 10 個まで作成できます。

チャネルに送信されるデータ

SORACOM Harvest Files イベントソースを設定したチャネルに送信されるデータは、MESSAGE と CONTEXT です。

実際に Flux アプリに送信されたデータは、SORACOM Flux Studio の [実行履歴] タブで確認できます。詳しくは、実行履歴 (ログ) を参照してください。

MESSAGE

Harvest Files で発生したイベントと、変化があったファイルパスです。

{
  "eventType": "updated",
  "path": "/harvest-files-path/filename",
  "contentType": "image/jpeg",
  "presignedUrls": {
    "get": "https://harvest-files.s3.ap-northeast-1.amazonaws.com/xxx"
  }
}
項目説明
eventType

発生したイベントタイプ。以下のいずれかです。

  • created: ファイル作成。ファイルが新規にアップロードされました。
  • updated: ファイル更新。既存のファイルと同名のファイルがアップロードされました。
  • deleted: ファイル削除。ファイルが削除されました。
pathファイルパス。ファイル名を含みます。
contentTypeファイルの contentType。
presignedUrls.get

作成または更新されたファイルを取得するための URL。ファイルが削除されたときは含まれません。

URL の有効期限は、イベントの発生から 1 時間です。

アクションで、イベントソースの MESSAGE を参照する場合は、${event.payload.<json パス>}event.payload.<json パス> == 1 のように入力します。

CONTEXT

{
  "eventType": "harvest_files",
  "configurationId": "01J1CH2MJRVxxxxxxxxxxxxxxx"
}
項目説明
eventTypeイベントの種類。SORACOM Harvest Files にファイルをアップロード (保存、更新) したり削除したりしたことが、Flux アプリが起動するトリガーになった場合は、harvest_files です。
configurationIdSORACOM Harvest Files イベントソースの設定ごとに異なる ID。Harvest Files で発行されます。

上記の CONTEXT を、アクションで参照する場合は、${event.context.<json パス>}event.context.<json パス> == "xxxxx" のように入力します。