カタログレイヤーの通知
OLP CLI は、次のものをサポートしています。
レイヤーレベルの通知を使用すると、特定のレイヤーで変更が発生したときに通知を受け取ることができます。 通知を受け取る変更を選択できます。
- レイヤー内のすべての変更。
- 地理的領域の変更。
- 特定のパーティションへの変更。
通知は基本的にデータストリームです。 通知はストリーム レイヤーにメッセージとして書き込まれ、レイヤーにサブスクライブすることで通知を受信します。また、 HERE platform 内の任意のストリーム レイヤーからデータを消費する場合と同様に、メッセージを使用します。
注
レイヤーレベルの通知は、 versioned
現在 HERE Tile Partitioning を使用するレイヤーでのみ利用できます。
カタログレイヤーの通知が作成されました
レイヤーの通知のサブスクリプションを作成します。 サブスクリプションを使用すると、特定のレイヤーで変更が発生したときに通知を受け取ることができます。
olp catalog layer notification create \
<notification catalog HRN> <notification stream layer ID> [command options]
olp catalog layer notification create ^
<notification catalog HRN> <notification stream layer ID> [command options]
必須パラメータ :
<notification catalog HRN>
ストリーム レイヤーと通知メッセージが含まれているカタログの HERE リソースネーム 。 <notification stream layer ID>
通知メッセージが含まれているストリーム レイヤーの ID 。 olp catalog layer add
コマンドを使用してストリーム レイヤーを作成したか 、 またはこのレイヤーのREAD
権限とWRITE
権限を持っている必要があります。 ストリーム レイヤーは、通知を受け取るレイヤーと同じカタログに含めることができます。 ストリーム レイヤーは複数のサブスクリプションで再利用できます。 ストリーム レイヤーの詳細について は、「カタログレイヤーのストリーム コマンド」を参照してください。 --source-catalog <source catalog HRN>
通知を受け取るレイヤーが含まれているカタログの HERE リソースネーム 。 --source-layers <sourceLayerID1 sourceLayerID2 ...>
通知を受信するレイヤーの ID の、スペースで区切られたリスト。
オプションのパラメータ :
--subscription-area <all|wkt[:"WKT Geometry Object"]|partitions[:"partitionID1 partitionID2 ..."]>
レイヤーのさまざまな部分の通知を有効にします。 デフォルト値はです all
。 指定できる値は次のとおりです。
Examples: all|wkt:"POINT (30 10)"|partitions:"partitionID1 partitionID2 ...".
--subscription-type <short|list|full>
通知メッセージに含める詳細のレベルを指定します。 デフォルト値はです full
。 サブスクリプションタイプの詳細について は、「通知の内容」を参照してください。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 --quiet
作成されたサブスクリプションの ID を表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
例 :
次のコマンド は、カタログhrn:here:data::org:source-catalog
のsource-layer
内にある特定のパーティションで変更が発生した場合に通知を受け取ることができるサブスクリプションを作成します。
通知は notification-layer
のに書き込ま hrn:here:data::org:notification-catalog
れます。 通知メッセージの内容が full
応答に設定されます。
olp catalog layer notification create \
hrn:here:data::org:notification-catalog notification-layer \
--source-catalog hrn:here:data::org:source-catalog \
--source-layers source-layer \
--subscription-area partitions:"partition-id" \
--subscription-type full
olp catalog layer notification create ^
hrn:here:data::org:notification-catalog notification-layer ^
--source-catalog hrn:here:data::org:source-catalog ^
--source-layers source-layer ^
--subscription-area partitions:"partition-id" ^
--subscription-type full
出力 :
Subscription 46d1ca2b-cad0-44d1-8a67-099dc08a0d40 has been created
通知メッセージの例 :
次のコマンドを実行して、通知メッセージを取得します。olp catalog layer stream get <notification catalog HRN> <notification layer ID>
。 サブスクリプションが作成されると notification-layer
、 source-layer
変更時に次の通知メッセージがに書き込まれます。
{
"catalogHRN":"hrn:here:data::org:source-catalog",
"catalogVersion":35,
"layerId":"source-layer",
"partitions":[
{
"version":35,
"partition":"partition-id",
"layer":"source-layer",
"dataHandle":"cf5325f3-fe68-413b-a94c-e1s616d54fc5",
"deleted":false
}
],
"timestamp":1637233214447,
"subscriptionResultType":"FULL"
}
カタログレイヤーの通知が削除されました
レイヤーの通知のサブスクリプションを削除します。
olp catalog layer notification delete \
<notification catalog HRN> <notification stream layer ID> [command options]
olp catalog layer notification delete ^
<notification catalog HRN> <notification stream layer ID> [command options]
必須パラメータ :
<notification catalog HRN>
通知メッセージが書き込まれるストリーム レイヤーを含むカタログの HERE リソースネーム 。 <notification stream layer ID>
通知メッセージの書き込み先となるストリーム レイヤーの ID 。
注
変更によって通知がトリガーされるカタログではなく、通知ストリームを含むカタログおよびレイヤーを指定してください。
オプションのパラメータ :
--subscription-ids <subscriptionID1 subscriptionID2 ...>
削除する特定のサブスクリプションのリスト。 このパラメータを指定しない場合、指定したレイヤーのすべてのサブスクリプションが削除されます。 -
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 --quiet
作成されたサブスクリプションの ID を表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
例 :
次のコマンド を使用すると、カタログhrn:here:data::org:notification-catalog
のレイヤーnotification-layer
に保存されている ID46d1ca2b-cad0-44d1-8a67-099dc08a0d40
のサブスクリプションが削除されます。
olp catalog layer notification delete \
hrn:here:data::org:notification-catalog notification-layer \
--subscription-ids 46d1ca2b-cad0-44d1-8a67-099dc08a0d40
olp catalog layer notification delete ^
hrn:here:data::org:notification-catalog notification-layer ^
--subscription-ids 46d1ca2b-cad0-44d1-8a67-099dc08a0d40
出力 :
Subscription 46d1ca2b-cad0-44d1-8a67-099dc08a0d40 has been deleted
カタログレイヤーの通知リスト
レイヤーの通知のサブスクリプションを一覧表示します。
olp catalog layer notification list \
<notification catalog HRN> <notification stream layer ID> [command options]
olp catalog layer notification list ^
<notification catalog HRN> <notification stream layer ID> [command options]
必須パラメータ :
<notification catalog HRN>
通知メッセージが書き込まれるストリーム レイヤーを含むカタログの HERE リソースネーム 。 <notification stream layer ID>
通知メッセージの書き込み先となるストリーム レイヤーの ID 。
注
変更によって通知がトリガーされるカタログではなく、通知ストリームを含むカタログおよびレイヤーを指定してください。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 --json
コマンドの結果を JSON 形式で表示します。 --quiet
作成されたサブスクリプションの ID を表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
例 :
以下のコマンドは notification-layer
、カタログのレイヤー用に作成されたサブスクリプション ID のリストを返し hrn:here:data::org:notification-catalog
ます。
olp catalog layer notification list \
hrn:here:data::org:notification-catalog notification-layer
olp catalog layer notification list ^
hrn:here:data::org:notification-catalog notification-layer
出力 :
46d1ws2b-cad0-44d1-8a67-099dc08a04f7
12w1ar0h-gec4-60c0-7d36-164wm11y43d1