Object Store Connector リファレンス

オブジェクトストアインスタンスのアクセスと作成を行う機能を提供するコネクタ。

設定


設定

デフォルト設定

パラメータ

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x 

Connection (接続)

この設定に指定できる接続型。

x 

接続種別

Connection (接続)

Runtime のデフォルトの ObjectStoreManager を返す ConnectionProvider

パラメータ
名前 説明 デフォルト値 必須

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されていると、関連付けられた再接続戦略を使い果たした後にテストに合格できなかった場合、デプロイに失敗します。

 

操作

Clear

<os:clear>

ストア内の全コンテンツを削除します。

パラメータ

名前 説明 デフォルト値 必須

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

Contains

<os:contains>

特定のキーに関連付けられている値があるかどうか確認します。キーに対する値がない場合、false が返されます。

この操作はキーレベルで同期されます。この操作の実行中、他の操作は同じオブジェクトストア上の同じキーにアクセスできなくなります。Runtime がクラスタモードで実行中の場合、この同期はノード間でも保証されます。

パラメータ

名前 説明 デフォルト値 必須

Key (キー)

String (文字列)

削除するオブジェクトのキー

x 

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

 

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。+

#[payload]

 

出力

Boolean (ブール)

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

  • OS:INVALID_KEY  

Remove

<os:remove>

特定のキーに関連付けられている値を削除します。キーに対する値がない場合、OS:KEY_NOT_FOUND エラーが発生します。

この操作はキーレベルで同期されます。この操作の実行中、他の操作は同じオブジェクトストア上の同じキーにアクセスできなくなります。Runtime がクラスタモードで実行中の場合、この同期はノード間でも保証されます。

パラメータ

名前 説明 デフォルト値 必須

Key (キー)

String (文字列)

削除するオブジェクトのキー

x 

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

  • OS:KEY_NOT_FOUND  

  • OS:INVALID_KEY  

Retrieve

<os:retrieve>

特定のキーについて保存されている値を取得します。

キーに対する値がない場合、動作は defaultValue パラメータに応じて異なります。

  • パラメータが指定されていないか、null 値に解決された場合、OS:KEY_NOT_FOUND エラーが発生します。

  • パラメータが指定されていて、null 値以外の場合、defaultValue が返されますが、保存はされません。

この操作はキーレベルで同期されます。この操作の実行中、他の操作は同じオブジェクトストア上の同じキーにアクセスできません。Runtime がクラスタモードで実行中の場合、この同期はノード間でも保証されます。

パラメータ

名前 説明 デフォルト値 必須

Key (キー)

String (文字列)

取得する値のキー

x 

Default Value (デフォルト値)

Any (任意)

ストアにキーが存在しない場合に返される値

 

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

 

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。+

#[payload]

 

出力

Any (いずれか)

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

  • OS:KEY_NOT_FOUND  

  • OS:INVALID_KEY  

Retrieve All

<os:retrieve-all>

+ ストア内の全キー/値ペアを取得します。+

パラメータ

名前 説明 デフォルト値 必須

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

 

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。+

#[payload]

 

出力

Object (オブジェクト)

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

Retrieve All Keys

<os:retrieve-all-keys>

現在 objectStore に値が保持されているすべてのキーを含むリストを返します。

パラメータ

名前 説明 デフォルト値 必須

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

 

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式で、その式の結果は対象変数に保存されます。+

#[payload]

 

出力

Array of String (文字列の配列)

スロー

  • OS:STORE_NOT_FOUND  

  • OS:STORE_NOT_AVAILABLE  

Store

<os:store>

特定のキーを使用して特定の値を保存します。

この操作は、failIfPresent の値に応じて、新しい値を保存するか、既存の値を更新する場合に使用できます。パラメータが false (デフォルト値) に設定されている場合、そのキーに関連付けられている既存の値があれば上書きされます。パラメータが true に設定されている場合、代わりに OS:KEY_ALREADY_EXISTS エラーが発生します。

もう 1 つの重要な考慮事項は null 値に関するものです。null 値の保存は許可されていません。ただし、一般的なユースケースでは、値を (ほとんどは式またはトランスフォーメーションを評価して) 取得し、値が null ではないことを検査し、値が存在すれば保存して他には何も行いません。failOnNullValue パラメータでこのユースケースが簡略化されます。デフォルト値の true の場合、null 値が指定されると OS:NULL_VALUE エラーが発生します。ただし、false に設定されている場合、null 値が指定されるとこの操作では何も行われず、エラーは発生しませんが、値が変更されることもありません。

さらに、この操作はキーレベルで同期されます。この操作の実行中、他の操作は同じオブジェクトストア上の同じキーにアクセスできなくなります。Runtime がクラスタモードで実行中の場合、この同期はノード間でも保証されます。

パラメータ

名前 説明 デフォルト値 必須

Key (キー)

String (文字列)

保存する値のキー

x 

Value (値)

Any (任意)

保存する値。failOnNullValue が true に設定されている場合、null にはできません。

#[payload]

 

Fail If Present (存在する場合は失敗)

Boolean (ブール)

キーがすでにストアにある場合、失敗するか、既存の値を更新するか

false

 

Fail On Null Value (null 値の場合は失敗)

Boolean (ブール)

値が null の場合、失敗するか、操作をスキップするか

true

 

Object Store (オブジェクトストア)

String (文字列)

使用する ObjectStore への参照。定義されていない場合は、Runtime のデフォルトパーティションが使用されます。

 

スロー

  • OS:STORE_NOT_FOUND  

  • OS:NULL_VALUE  

  • OS:STORE_NOT_AVAILABLE  

  • OS:KEY_ALREADY_EXISTS  

  • OS:INVALID_KEY  

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub