Actions トリガー: event-stream - API オブジェクト

event-stream Action トリガーのAPIオブジェクトについて説明します。

event-stream Actions トリガーのAPIオブジェクトには、次のものが含まれます。

​

api.cache

実行間で保持されるデータを保存および取得します。

​

api.cache.delete(key)

指定した key に対応するキャッシュ値のレコードが存在する場合は、削除します。

key · string

削除するキャッシュレコードのキー。

​

api.cache.get(key)

指定したキーに対応するキャッシュ済みの値を表すレコードが存在する場合は、 それを取得します。 レコードが見つかった場合、キャッシュされた値は返されたオブジェクトの value プロパティに格納されています。

key · string

キャッシュに保存されているレコードのキーです。

​

api.cache.set(key, value, options)

指定したキーに対応する文字列値をキャッシュに保存または更新します。

このキャッシュに保存された値のスコープは、それを設定した トリガー に限定されます。 また、Actions Cache Limits の制限が適用されます。

この方法で保存された値の有効期間は、指定された ttl または expires_at の値までの 最大 となります。有効期間が指定されていない場合は、デフォルトで 15 分が使用されます。有効期間は、 Actions Cache Limits に記載されている最大時間を超えることはできません。

重要: このキャッシュは、短期間のみ保持される一時的なデータ向けに設計されています。項目は、 指定された有効期間内であっても、後続のトランザクションでは利用できない場合があります。

key · string

保存するレコードのキー。

value · string

保存するレコードの値。

options · cachesetoptions · optional

キャッシュの動作を調整するためのオプションです。

非表示 options properties

expires_at · number · optional

Unix エポックからの経過時間をミリ秒で表した絶対有効期限です。 キャッシュされたレコードはこれより前に削除される場合がありますが、 指定された expires_at を超えて保持されることはありません。

注: ttl にも値が 指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、 2 つのうち早い方の有効期限が使用されます。

ttl · number · optional

このキャッシュエントリの有効期間をミリ秒で指定する値です。 キャッシュされた値はこれより前に削除される場合がありますが、 指定された ttl を超えて保持されることはありません。

注: expires_at にも値が 指定されている場合、この値は指定しないでください。両方のオプションが指定された場合は、 2 つのうち早い方の有効期限が使用されます。