Data Grid REST API

XML または JSON 設定をペイロードに含む POST リクエストで、Data Grid クラスター全体に名前付きキャッシュを作成します。

POST /rest/v2/caches/{cacheName}

<infinispan>
    <cache-container>
        <distributed-cache name="cacheName" mode="SYNC">
            <memory>
                <object size="20"/>
            </memory>
        </distributed-cache>
    </cache-container>
</infinispan>

{
  "distributed-cache": {
    "mode": "SYNC",
    "memory": {
      "object": {
        "size": 20
      }
    }
  }
}

HEAD リクエストで Data Grid クラスターでキャッシュが利用可能かどうかを確認します。

HEAD /rest/v2/caches/{cacheName}

POST リクエストと ?template= パラメーターを使用して、Data Grid テンプレートからキャッシュを作成します。

POST /rest/v2/caches/{cacheName}?template={templateName}

GET リクエストで Data Grid のキャッシュ設定を取得します。

GET /rest/v2/caches/{name}?action=config

有効な XML 設定と ?action=toJSON パラメーターを使用して POST 要求を呼び出します。Data Grid は、設定の同等の JSON 表現で応答します。

POST /rest/v2/caches?action=toJSON

GET リクエストを呼び出し、Data Grid キャッシュのすべての詳細を取得します。

GET /rest/v2/caches/{name}

Data Grid は、以下のような JSON レスポンスを提供します。

{
  "stats": {
    "time_since_start": -1,
    "time_since_reset": -1,
    "hits": -1,
    "current_number_of_entries": -1,
    "current_number_of_entries_in_memory": -1,
    "total_number_of_entries": -1,
    "stores": -1,
    "off_heap_memory_used": -1,
    "data_memory_used": -1,
    "retrievals": -1,
    "misses": -1,
    "remove_hits": -1,
    "remove_misses": -1,
    "evictions": -1,
    "average_read_time": -1,
    "average_read_time_nanos": -1,
    "average_write_time": -1,
    "average_write_time_nanos": -1,
    "average_remove_time": -1,
    "average_remove_time_nanos": -1,
    "required_minimum_number_of_nodes": -1
  },
  "size": 0,
  "configuration": {
    "distributed-cache": {
      "mode": "SYNC",
      "transaction": {
        "stop-timeout": 0,
        "mode": "NONE"
      }
    }
  },
  "rehash_in_progress": false,
  "bounded": false,
  "indexed": false,
  "persistent": false,
  "transactional": false,
  "secured": false,
  "has_remote_backup": false,
  "indexing_in_progress": false,
  "statistics": false
}

POST リクエストでキャッシュにエントリーを追加します。

POST /rest/v2/caches/{cacheName}/{cacheKey}

前述の要求は cacheKey キーで cacheName を指定のキャッシュに、ペイロード、またはリクエストボディを配置します。リクエストは、既存のデータを置き換え、適用可能であれば、Time-To-Live と Last-Modified の値を更新します。

指定されたキーの値がすでに存在する場合、POST リクエストは HTTP CONFLICT ステータスを返し、値を変更しません。値を更新するには、PUT リクエストを使用する必要があります。エントリーの入れ替え をご覧ください。

キャッシュ内のエントリーを PUT リクエストに置き換えます。

PUT /rest/v2/caches/{cacheName}/{cacheKey}

指定されたキーの値がすでに存在する場合、 PUT 要求は値を更新します。既存の値を変更したくない場合は、値を変更する代わりに HTTP CONFLICT ステータスを返す POST リクエストを使用します。値の追加 を参照してください。

GET リクエストを使用して特定のキーのデータを取得します。

GET /rest/v2/caches/{cacheName}/{cacheKey}

サーバーは、応答本文の指定されたキー cacheKey の下にある指定されたキャッシュ cacheName からデータを返します。応答には、MediaType ネゴシエーションに対応する Content-Type ヘッダーが含まれています。

GET /rest/v2/caches/{cacheName}/{cacheKey}?extended

HEAD リクエストで特定のエントリーが存在することを確認します。

HEAD /rest/v2/caches/{cacheName}/{cacheKey}

上記のリクエストは、ヘッダーフィールドと、エントリーとともに保存したものと同じコンテンツのみを返します。たとえば、文字列を保存した場合、リクエストは文字列を返します。バイナリー、base64 エンコード、blob、またはシリアル化された Java オブジェクトを保存した場合、DataGrid はリクエストのコンテンツを逆シリアル化しません。

DELETE リクエストを使用してキャッシュからエントリーを 削除 します。

DELETE /rest/v2/caches/{cacheName}/{cacheKey}

DELETE リクエストを使用して Data Grid クラスターからキャッシュを DELETE 削除します。

DELETE /rest/v2/caches/{cacheName}

GET リクエストを呼び出して、キャッシュ内のすべてのキーを JSON 形式で取得します。

GET /rest/v2/caches/{cacheName}?action=keys

キャッシュからすべてのデータを削除するには、GET リクエストに ?action=clear パラメーターを付けて実行します。

GET /rest/v2/caches/{cacheName}?action=clear

GET リクエストと ?action=size パラメーターを使用して、クラスター全体のキャッシュのサイズを取得します。

GET /rest/v2/caches/{cacheName}?action=size

GET リクエストを使用してキャッシュの実行時統計を取得します。

GET /rest/v2/caches/{cacheName}?action=stats

GET リクエストと ?action=search&query パラメーターを使用して、キャッシュに対して Ickle クエリーを実行します。

GET /rest/v2/caches/{cacheName}?action=search&query={ickle query}

Data Grid は、次のようなクエリーヒットで応答します。

{
  "total_results" : 150,
  "hits" : [ {
    "hit" : {
      "name" : "user1",
      "age" : 35
    }
  }, {
    "hit" : {
       "name" : "user2",
       "age" : 42
    }
  }, {
    "hit" : {
       "name" : "user3",
       "age" : 12
    }
  } ]
}

クエリーパラメーターを指定せずにリクエストの本文を使用するには、以下のように POST リクエストを呼び出します。

POST /rest/v2/caches/{cacheName}?action=search

次の例は、リクエスト本文のクエリーを示しています。

{
 "query":"from Entity where name:\"user1\"",
 "max_results":20,
 "offset":10
}

GET リクエストと ?action=mass-index&mode={mode} パラメーターを使用して、キャッシュ内のすべてのデータのインデックスを再作成します。

GET  /v2/caches/{cacheName}/search/indexes?action=mass-index&mode={mode}

mode パラメーターの値は以下の通りです。

GET リクエストと ?action=clear パラメーターを使用して、キャッシュからすべてのインデックスを削除します。

GET  /v2/caches/{cacheName}/search/indexes?action=clear

GET リクエストでキャッシュ内のインデックスの情報を取得します。

GET /v2/caches/{cacheName}/search/indexes/stats

Data Grid は、以下のような JSON レスポンスを提供します。

{
    "indexed_class_names": ["org.infinispan.sample.User"],
    "indexed_entities_count": {
        "org.infinispan.sample.User": 4
    },
    "index_sizes": {
        "cacheName_protobuf": 14551
    },
    "reindexing": false
}

GET リクエストでキャッシュに実行されたクエリーの情報を取得します。

GET /v2/caches/{cacheName}/search/query/stats

Data Grid は、以下のような JSON レスポンスを提供します。

{
    "search_query_execution_count":20,
    "search_query_total_time":5,
    "search_query_execution_max_time":154,
    "search_query_execution_avg_time":2,
    "object_loading_total_time":1,
    "object_loading_execution_max_time":1,
    "object_loading_execution_avg_time":1,
    "objects_loaded_count":20,
    "search_query_execution_max_time_query_string": "FROM entity"
}

GET リクエストと ?action=clear パラメーターを使用して、ランタイムの統計情報をリセットすることができます。

GET /v2/caches/{cacheName}/search/query/stats?action=clear

GET リクエストを使用して、 Data Grid クラスターで使用可能なすべてのキャッシュを一覧表示します。

GET /rest/v2/caches/

Data Grid REST API を使用して、クロスサイトレプリケーション操作を行います。

GET /v2/caches/{cacheName}/x-site/backups/

{
  "NYC": "online",
  "LON": "offline"
}

GET /v2/caches/{cacheName}/x-site/backups/{siteName}

{
  "NodeA":"offline",
  "NodeB":"online"
}

GET /v2/caches/{cacheName}/x-site/backups/{siteName}?action=take-offline

GET /v2/caches/{cacheName}/x-site/backups/{siteName}?action=bring-online

GET /v2/caches/{cacheName}/x-site/backups/{siteName}?action=start-push-state

GET /v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-push-state

GET /v2/caches/{cacheName}/x-site/backups?action=push-state-status

{
   "NYC":"CANCELED",
   "LON":"OK"
}

GET /v2/caches/{cacheName}/x-site/local?action=clear-push-state-status

GET /v2/caches/{cacheName}/x-site/backups/{siteName}?action=cancel-receive-state

Data Grid クラスター間でキャッシュデータのローリングアップグレードを実行します

GET /v2/caches/{cacheName}?action=sync-data

GET /v2/caches/{cacheName}?action=disconnect-source

ペイロードに設定が含まれる POST リクエストでカウンターを作成します。

POST /rest/v2/counters/{counterName}

{
    "weak-counter":{
        "initial-value":5,
        "storage":"PERSISTENT",
        "concurrency-level":1
    }
}

{
    "strong-counter":{
        "initial-value":3,
        "storage":"PERSISTENT",
        "upper-bound":5
    }
}

DELETE リクエストで特定のカウンターを削除します。

DELETE /rest/v2/counters/{counterName}

GET リクエストで特定のカウンターの設定を取得します。

GET /rest/v2/counters/{counterName}/config

Data Grid は、JSON 形式でカウンターの設定を応答します。

POST リクエストを使用して、特定のカウンターに値を追加します。

POST /rest/v2/counters/{counterName}

リクエストペイロードが空の場合、カウンターは 1 つずつ増えます。そうでないと、ペイロードは signed long として解釈され、カウンターに追加されます。

GET リクエストでカウンターの値を取得します。

GET /rest/v2/counters/{counterName}

GET リクエストと ?action=reset パラメーターなしでカウンターの初期値を復元します。

GET /rest/v2/counters/{counterName}?action=reset

GET リクエストに ?action=increment パラメーターを指定して、カウンターの値を増加させます。

GET /rest/v2/counters/{counterName}?action=increment

?action=add および delta パラメーターを含む GET リクエストで、カウンターに任意の値を追加します。

GET /rest/v2/counters/{counterName}?action=add&delta={delta}

カウンターの値を減少させるには、GET リクエストと ?action=decrement パラメーターを使用します。

GET /rest/v2/counters/{counterName}?action=decrement

GET リクエストと compareAndSet パラメーターを使って、強力なカウンターの値をアトミックに設定します。

GET /rest/v2/counters/{counterName}?action=compareAndSet&expect={expect}&update={update}

Data Grid は、現在の値が {expect} の場合、{update} にアトミックに値を設定します。操作が成功した場合、Data Grid は true.

GET リクエストと compareAndSwap パラメーターで強力なカウンターの値をアトミックに設定します。

GET /rest/v2/counters/{counterName}?action=compareAndSwap&expect={expect}&update={update}

Data Grid は、現在の値が {expect} の場合、{update} にアトミックに値を設定します。操作が成功すると、 Data Grid はペイロードの前の値を返します。

GET リクエストで Data Grid クラスターのカウンターのリストを取得します。

GET /rest/v2/counters/

GET リクエストで Cache Manager の情報を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}

Data Grid は、次の例のように、JSON 形式の情報で応答します。

{
    "version":"xx.x.x-FINAL",
    "name":"default",
    "coordinator":true,
    "cache_configuration_names":[
        "___protobuf_metadata",
        "cache2",
        "CacheManagerResourceTest",
        "cache1"
    ],
    "cluster_name":"ISPN",
    "physical_addresses":"[127.0.0.1:35770]",
    "coordinator_address":"CacheManagerResourceTest-NodeA-49696",
    "cache_manager_status":"RUNNING",
    "created_cache_count":"3",
    "running_cache_count":"3",
    "node_address":"CacheManagerResourceTest-NodeA-49696",
    "cluster_members":[
        "CacheManagerResourceTest-NodeA-49696",
        "CacheManagerResourceTest-NodeB-28120"
    ],
    "cluster_members_physical_addresses":[
        "127.0.0.1:35770",
        "127.0.0.1:60031"
    ],
    "cluster_size":2,
    "defined_caches":[
        {
            "name":"CacheManagerResourceTest",
            "started":true
        },
        {
            "name":"cache1",
            "started":true
        },
        {
            "name":"___protobuf_metadata",
            "started":true
        },
        {
            "name":"cache2",
            "started":true
        }
    ]

}

GET リクエストを使用して Data Grid クラスターのヘルス情報を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/health

Data Grid は、次の例のように、JSON 形式のクラスターヘルス情報で応答します。

{
    "cluster_health":{
        "cluster_name":"ISPN",
        "health_status":"HEALTHY",
        "number_of_nodes":2,
        "node_names":[
            "NodeA-36229",
            "NodeB-28703"
        ]
    },
    "cache_health":[
        {
            "status":"HEALTHY",
            "cache_name":"___protobuf_metadata"
        },
        {
            "status":"HEALTHY",
            "cache_name":"cache2"
        },
        {
            "status":"HEALTHY",
            "cache_name":"mycache"
        },
        {
            "status":"HEALTHY",
            "cache_name":"cache1"
        }
    ]

}

認証を必要としない GET リクエストを使用してキャッシュマネージャーのヘルスステータスを取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/health/status

Data Grid は以下のいずれかを text/plain 形式で応答します。

HEAD リクエストを使用して Data Grid サーバーの REST エンドポイントの可用性を確認します。

HEAD /rest/v2/cache-managers/{cacheManagerName}/health

正常な応答コードを受信した場合、Data Grid REST サーバーが実行され、要求を処理しています。

GET 要求を使用してキャッシュマネージャーのグローバル設定を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/config

GET リクエストを使用してすべてのキャッシュの設定を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs

Data Grid は、以下の例のように、各キャッシュとキャッシュ設定を含む JSON 配列で応答します。

[
  {
      "name":"cache1",
      "configuration":{
          "distributed-cache":{
              "mode":"SYNC",
              "partition-handling":{
                  "when-split":"DENY_READ_WRITES"
              },
              "statistics":true
          }
      }
  },
  {
      "name":"cache2",
      "configuration":{
          "distributed-cache":{
              "mode":"SYNC",
              "transaction":{
                  "mode":"NONE"
              }
          }
      }
  }
]

GET リクエストで、利用可能なすべての Data Grid キャッシュテンプレートを取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/cache-configs/templates

Cache Manager で利用可能なすべてのキャッシュのリストを、キャッシュ・ステータスおよび詳細とともに、GET 要求で取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/caches

Data Grid は、次の例のように、使用可能な各キャッシュを一覧表示して説明する JSON 配列で応答します。

[ {
  "status" : "RUNNING",
  "name" : "cache1",
  "type" : "local-cache",
  "simple_cache" : false,
  "transactional" : false,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}, {
  "status" : "RUNNING",
  "name" : "cache2",
  "type" : "distributed-cache",
  "simple_cache" : false,
  "transactional" : true,
  "persistent" : false,
  "bounded": false,
  "secured": false,
  "indexed": true,
  "has_remote_backup": true,
  "health":"HEALTHY"
}]

GET リクエストを使用してキャッシュマネージャーの統計を取得します。

GET /rest/v2/cache-managers/{cacheManagerName}/stats

Data Grid は、次の例のように、JSON 形式のキャッシュマネージャー統計で応答します。

{
    "statistics_enabled":true,
    "read_write_ratio":0.0,
    "time_since_start":1,
    "time_since_reset":1,
    "number_of_entries":0,
    "total_number_of_entries":0,
    "off_heap_memory_used":0,
    "data_memory_used":0,
    "misses":0,
    "remove_hits":0,
    "remove_misses":0,
    "evictions":0,
    "average_read_time":0,
    "average_read_time_nanos":0,
    "average_write_time":0,
    "average_write_time_nanos":0,
    "average_remove_time":0,
    "average_remove_time_nanos":0,
    "required_minimum_number_of_nodes":1,
    "hits":0,
    "stores":0,
    "current_number_of_entries_in_memory":0,
    "hit_ratio":0.0,
    "retrievals":0
}

Cache Managers でクロスサイト操作を行うと、すべてのキャッシュに操作が適用されます。

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/

{
   "SFO-3":{
      "status":"online"
   },
   "NYC-2":{
      "status":"mixed",
      "online":[
         "CACHE_1"
      ],
      "offline":[
         "CACHE_2"
      ]
   }
}

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=take-offline

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=bring-online

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=start-push-state

GET /rest/v2/cache-managers/{cacheManagerName}/x-site/backups/{siteName}?action=cancel-push-state

GET リクエストを使用して Data Grid サーバーに関する基本情報を表示します。

GET /rest/v2/server

Data Grid は、次の例のように、サーバー名、コードネーム、およびバージョンを JSON 形式で応答します。

{
  "version":"Infinispan 'Codename' xx.x.x.Final"
}

GET リクエストで Data Grid サーバーのキャッシュマネージャーのリストを取得します。

GET /rest/v2/server/cache-managers

Data Grid は、サーバー用に設定されたキャッシュマネージャー名の配列で応答します。

特定のキャッシュをクライアントの要求から一時的に除外するように Data Grid を設定します。キャッシュマネージャー名とキャッシュの名前を含む POST リクエストを送信します。

POST /v2/server/ignored-caches/{cache-manager}/{cache}

Data Grid は、REST クライアントリクエストのサービスが利用できないステータス (503) と、Hot Rod クライアントリクエストのサーバーエラー (code 0x85) を返します。

DELETE リクエストでキャッシュを無視リストから削除します。

DELETE /v2/server/ignored-caches/{cache-manager}/{cache}

GET リクエストでキャッシュが無視されることを確認します。

GET /v2/server/ignored-caches/{cache-manager}

GET リクエストで Data Grid サーバーの設定を取得します。

GET /rest/v2/server/config

Data Grid は、以下のように JSON 形式で設定を応答します。

{
    "server":{
        "interfaces":{
            "interface":{
                "name":"public",
                "inet-address":{
                    "value":"127.0.0.1"
                }
            }
        },
        "socket-bindings":{
            "port-offset":0,
            "default-interface":"public",
            "socket-binding":[
                {
                    "name":"memcached",
                    "port":11221,
                    "interface":"memcached"
                }
            ]
        },
        "security":{
            "security-realms":{
                "security-realm":{
                    "name":"default"
                }
            }
        },
        "endpoints":{
            "socket-binding":"default",
            "security-realm":"default",
            "hotrod-connector":{
                "name":"hotrod"
            },
            "rest-connector":{
                "name":"rest"
            }
        }
    }
}

GET リクエストで Data Grid サーバーのすべての環境変数を取得します。

GET /rest/v2/server/env

GET リクエストで Data Grid サーバーの JVM メモリー使用量情報を取得します。

GET /rest/v2/server/memory

Data Grid は、ヒープと非ヒープのメモリー統計、直接のメモリー使用量、メモリープールとガベージコレクションに関する情報を JSON 形式で応答します。

GET リクエストで、JVM の現在のスレッドダンプを取得します。

GET /rest/v2/server/threads

Data Grid は現在のスレッドダンプを text/plain 形式で応答します。

GET リクエストで Data Grid サーバーを停止します。

GET /rest/v2/server?action=stop

Data Grid は 200(OK) で応答し、実行を停止します。

GET リクエストを使用して Data Grid クラスター全体をシャットダウンします。

GET /rest/v2/cluster?action=stop

Data Grid は 200(OK) で応答し、クラスター全体を順番にシャットダウンします。

GET リクエストに ?action=stop&server パラメーターを指定して、Data Grid クラスター内の 1 つまたは複数の特定のサーバーをシャットダウンすることができます。

GET /rest/v2/cluster?action=stop&server={server1_host}&server={server2_host}

Data Grid は 200(OK) で応答します。

GET リクエストで利用可能なサーバータスクに関する情報を表示します。

GET /rest/v2/tasks

Data Grid は、利用可能なタスクのリストで応答します。リストには、次の例のように、タスクの名前、タスクを処理するエンジン、タスクの名前付きパラメーター、タスクの実行モード (ONE_NODE または ALL_NODES)、許可されるセキュリティーロールが JSON 形式で記載されています。

[
  {
    "name": "SimpleTask",
    "type": "TaskEngine",
    "parameters": [
      "p1",
      "p2"
    ],
    "execution_mode": "ONE_NODE",
    "allowed_role": null
  },
  {
    "name": "RunOnAllNodesTask",
    "type": "TaskEngine",
    "parameters": [
      "p1"
    ],
    "execution_mode": "ALL_NODES",
    "allowed_role": null
  },
  {
    "name": "SecurityAwareTask",
    "type": "TaskEngine",
    "parameters": [],
    "execution_mode": "ONE_NODE",
    "allowed_role": "MyRole"
  }
]

タスクの実行は、タスク名と param を先頭につけた必須パラメーターを含む GET リクエストで行います。

GET /rest/v2/tasks/myTask?action=exec&param.p1=v1&param.p2=v2

Data Grid はタスクの結果で応答します。

PUT または POST リクエストでスクリプトタスクをアップロードします。

リクエストのコンテンツペイロードとしてスクリプトを提供します。Data Grid がスクリプトをアップロードした後、GET リクエストでスクリプトを実行することができます。

POST /rest/v2/tasks/taskName

さまざまな形式でデータの書き込みと読み取りを行うことができ、DataGrid は必要に応じてそれらの形式間で変換できます。

次の標準フォーマットは交換可能です。

上記のデータ形式を次の形式に変換することもできます。

Data Grid では、application/x-protostream と application/json の間で変換することもできます。

REST API へのすべての呼び出しは、書き込まれたコンテンツまたは読み取るときに必要なコンテンツの形式を説明するヘッダーを提供できます。Data Grid は、値に適用される標準的な HTTP/1.1 ヘッダーの "Content-Type "と "Accept "に加えて、キーに同様の効果を持つ "Key-Content-Type "をサポートしています。

Data Grid REST エンドポイントは RFC-2616 Accept ヘッダーに準拠しており、サポートされている変換に基づいて正しい MediaType をネゴシエートします。

例えば、データ読み込み時に次のようなヘッダーを送信します。

Accept: text/plain;q=0.7, application/json;q=0.8, */*;q=0.6

上記のヘッダーにより、Data Grid は最初にコンテンツを JSON 形式 (優先度 0.8) で返します。保存形式を JSON に変換できない場合、Data Grid は次の形式である text/plain を試みます (2 番目に高い優先度 0.7)。最後に、Data Grid は*/*にフォールバックし、キャッシュの設定に基づいて適切なフォーマットを選択します。

REST リソースの作成には、URL の一部となる名前が必要です。この名前に RFC 3986 仕様のセクション 2.2 で定義されている特殊文字が含まれている場合には、Percent encoding メカニズムでエンコードする必要があります。

ほとんどの REST API コールでは、URL に Key が含まれています。Data Grid は、これらの呼び出しを処理する際に、Key がjava.lang.Stringであることを前提としていますが、異なるフォーマットのキーに対しては、特定のヘッダーKey-Content-Typeを使用することができます。

API 呼び出し:

`PUT /my-cache/AQIDBDM=`

ヘッダー:

Key-Content-Type: application/octet-stream

API 呼び出し:

GET /my-cache/0x01CA03042F

ヘッダー:

Key-Content-Type: application/octet-stream; encoding=hex

API 呼び出し:

POST /my-cache/3.141456

ヘッダー:

Key-Content-Type: application/x-java-object;type=java.lang.Double

application/x-java-object の type パラメーターは次のように制限されています。

キャッシュがインデックス化されている場合や、application/x-protostream を保存するように特別に設定されている場合、Protostream との間で自動的に変換された JSON ドキュメントを送受信することができます。

変換を機能させるには、protobuf スキーマを登録する必要があります。

REST 経由で protobuf スキーマを登録するには、次の例のように、POST または PUT を呼び出して ___protobuf_metadata キャッシュを起動します。

curl -u user:password -X POST --data-binary @./schema.proto http://127.0.0.1:11222/rest/v2/caches/___protobuf_metadata/schema.proto

JSON ドキュメントを記述する際には、ドキュメントに対応する Protobuf Message を識別するための特別なフィールド _type は、ドキュメントに対応する protobuf Messageを識別するために、ドキュメント内に存在する必要があります。

たとえば、以下のスキーマについて考えてみましょう。

message Person  {
  required string name = 1;
  required int32 age = 2;
}

対応する JSON ドキュメントは以下のとおりです。

{
   "_type": "Person",
   "name": "user1",
   "age": 32
}