API オブジェクト

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

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

​

api.cache

実行をまたいで保持されるデータを保存・取得します。

​

api.cache.delete(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

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

表示 options プロパティ

expires_at · number

unix epoch からのミリ秒単位の絶対有効期限。 キャッシュされたレコードはそれより前に削除される場合がありますが、 指定した expires_at を超えて保持されることはありません。

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

ttl · number

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

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