スキーマ

OLP CLI は、次のものをサポートしています。

スキーマリスト

アクセスできるすべてのスキーマが一覧表示されます。

olp schema list [filter] [command options]

オプションのパラメータ :

  • [filter] スキーマリストのフィルタリングに使用される freeform テキスト。 フィルタ filter は、スキーマの HERE リソースネーム 、名前、または概要に文字列が含まれているかどうかを確認します。 filter 文字列にレルムのない HERE リソースネーム が含まれている場合、 OLP CLI はそのレルムが含まれているスキーマも HERE リソースネーム で返します。
  • --limit <max number of schemas> 返されるスキーマの最大数を指定します。 指定しない場合は、使用可能なすべてのスキーマが返されます。
  • --type <proto|json> 返されるスキーマのタイプを指定します。 省略すると、すべての型が返されます。
  • --only-layer-schema 応答がレイヤースキーマのリストのみを返すかどうかを示します。 値がに設定され falseている場合、応答には非レイヤースキーマも含まれ trueます。デフォルト値はです。 レイヤースキーマの詳細については、「 Protobuf スキーマ をプラットフォームに公開」を参照してください。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json コマンドの結果を JSON 形式で表示します。
  • --quiet スキーマ HRNS を新しい行に表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

例 :

olp schema list "RIB 1.25.0 Topology" --json

出力 :

次の例では RIB 1.25.0 Topology 、 name または summary フィールドの用語を使用してアクセスできるすべてのスキーマを一覧表示しています。


{"schemas": [{
    "summary": "Topology provides the representation of a topology network.",
    "hrn": "hrn:here:schema::org:com.here.schema.rib:topology_v1:1.25.0",
    "created": "2018-04-19T05:11:09.523Z",
    "groupId": "com.here.schema.rib",
    "name": "RIB 1.25.0 Topology",
    "artifactId": "topology_v1",
    "updated": "2018-04-19T05:11:54.225Z",
    "version": "1.25.0"
}]}

スキーマショー

指定したスキーマの詳細を表示します。

olp schema show <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマの HERE リソースネーム 。

オプションのパラメータ :

  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json コマンドの結果を JSON 形式で表示します。
  • --quiet スキーマ 名を表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドを実行すると、センサデータインジェストインタフェース（ SDII ）スキーマの詳細が JSON 形式で表示されます。


olp schema show hrn:here:schema::org:com.here.sdii:sdii_common_v3:3.3.8 --json

出力 :


{
    "summary": "SDII schemas made available through HERE platform are Open Standard Schema specifications.
    Sensor Data Ingestion Interface (SDII) is a vehicle based, sensor data format for the
    transmission of data between a vehicle and the Cloud. This data format consists of events (for example,
    vehicle position, sign recognition, object detection) where an event might be built from one or
    more attributes (for example, lat/lon and altitude of a vehicle). All events include a time stamp based
    on the actual event time. Each position of a vehicle is also provided with a timestamp. Events
    can be related to positions by corresponding event and position time stamps.\nSDII Schema,
    Common: contains definitions of events and attributes of a message. SDII Schema, Message: is a
    container as a delivery package which consists of SDII Schema, Common. SDII Schema, Message
    List: is a container for multiple individual SDII Schema, Messages enabling you to send
    multiple messages within a single Protobuf container thereby optimizing your data
    transmission.",
    "schemaValidationResults": [{
        "fileExtension": true,
        "module": "proto",
        "packageConsistency": false,
        "backwardsCompatibility": true,
        "googleStyle": false,
        "majorVersionInPackage": true
    }],
    "hrn": "hrn:here:schema::org:com.here.sdii:sdii_common_v3:3.3.8",
    "created": "2019-04-11T18:57:04.828Z",
    "groupId": "com.here.sdii",
    "name": "SDII v3 Schema, Common",
    "artifactId": "sdii_common_v3",
    "type": "proto",
    "updated": "2019-05-06T11:26:17.734Z",
    "version": "3.3.8",
    "variants": [{
        "id": "doc",
        "url": "https://openlocation.here.com/file/2136/download?token=7ZxUMafg"
    }],
    "artifacts": [
        {
            "hrn": "hrn:here:artifact::org:com.here.sdii:sdii_common_v3_java:3.3.8",
            "created": "2019-04-11T18:57:22.204Z",
            "groupId": "com.here.sdii",
            "artifactId": "sdii_common_v3_java",
            "version": "3.3.8",
            "updated": "2019-04-11T18:57:22.204Z"
        },
        {
            "hrn": "hrn:here:artifact::org:com.here.sdii:sdii_common_v3_proto:3.3.8",
            "created": "2019-04-11T18:57:10.456Z",
            "groupId": "com.here.sdii",
            "artifactId": "sdii_common_v3_proto",
            "version": "3.3.8",
            "updated": "2019-04-11T18:57:10.456Z"
        },
        {
            "hrn": "hrn:here:artifact::org:com.here.sdii:sdii_common_v3_scala:3.3.8",
            "created": "2019-04-11T18:58:16.060Z",
            "groupId": "com.here.sdii",
            "artifactId": "sdii_common_v3_scala",
            "version": "3.3.8",
            "updated": "2019-04-11T18:58:16.060Z"
        }
    ]
}

スキーマが削除されます

スキーマ HERE リソースネーム によってスキーマが削除されます。

olp schema delete <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマ の HERE リソースネーム 。 HERE リソースネーム はバージョンなしで使用できます

オプションのパラメータ :

  • --force プロジェクトにリンクされている場合でもスキーマ を強制的に削除します。また、 HERE リソースネーム でバージョンが指定されていない場合は、既存のすべてのバージョンを強制的に削除します
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

注

マーケットプレイスの準備完了とマークされました

[Ready for Marketplace] とマークされたカタログに関連付けられているスキーマ は削除できません。

例 :

次のコマンド hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 を実行すると、 HERE リソースネーム を含むスキーマがプラットフォームから削除されます。


olp schema delete hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0

hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 上記の例のスキーマ HERE リソースネーム は、独自のスキーマの HERE リソースネーム を渡すプレースホルダーとして機能します。

スキーマ取得

指定したスキーマパッケージをダウンロードします。

olp schema get <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマの HERE リソースネーム 。

オプションのパラメータ :

  • --output <path to dir> ダウンロードしたスキーマ ZIP パッケージを保存する出力ディレクトリ。 指定しない場合、現在のディレクトリがデフォルトで使用されます。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json コマンドの結果を JSON 形式で表示します。
  • --quiet ダウンロードされたスキーマパッケージへの絶対パスを表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

次のコマンド hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 を使用すると、プラットフォームから HERE リソースネーム を含むスキーマパッケージがダウンロードされます。


olp schema get hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0

hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 上記の例のスキーマ HERE リソースネーム は、独自のスキーマの HERE リソースネーム を渡すプレースホルダーとして機能します。

スキーマ権限リスト

スキーマに関連付けられているすべての組織のユーザー、アプリ、グループの権限を一覧表示します。

olp schema permission list <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマの HERE リソースネーム 。

オプションのパラメータ :

  • --type <app|group|user> 一覧表示するエンティティのタイプを指定します。
  • --limit <max number of entities> 結果に返されるエンティティの最大数を指定します（デフォルトは 100 ）。
  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --json コマンドの結果を JSON 形式で表示します。
  • --quiet エンティティの HRNS を新しい行に表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

Linux
窓
olp schema permission list hrn:here:schema::org:com.here.example:test_schema_v1:* \
--json
olp catalog permission list hrn:here:schema::org:com.here.example:test_schema_v1:* ^
--json

出力 :


{"entityGrants": [
{
"entityId": {
"id": "HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3",
"hrn": "hrn:here:account::org:user/HERE-05966c89-aaf1-4ae2-b0e4-3676b3f8b8c3",
"realmHrn": "hrn:here:account::org:realm/org",
"type": "user"
},
"permissions": [
{
"id": "PERM-7heTYzsR05VR_p3IeyaZKDdlVPb1zJJUmzLI9JUEDcc",
"action": "read",
"effect": "allow",
"resource": "hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0",
"serviceId": "SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a"
},
{
"id": "PERM-7heTYzsR0RV5_p3IeyaZKDdlVPb1zJJUmzLI9JUDEbb",
"action": "write",
"effect": "allow",
"resource": "hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0",
"serviceId": "SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a"
}
]
},
{
"entityId": {
"id": "my-app-1234",
"hrn": "hrn:here:account::org2:app/my-app-1234",
"realmHrn": "hrn:here:account::org2:realm/org2",
"type": "app"
},
"permissions": [
{
"id": "PERM-7heTYzsR05VR_p3IeyaZKDdlVPb1zJJUmzKJ9JUECdd",
"action": "manage",
"effect": "allow",
"resource": "hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0",
"serviceId": "SERVICE-b9acbead-4666-487e-88b0-cfb64ed0ac6a"
}
]
}
]
}

スキーマ権限の付与

スキーマで選択したアクションを実行する権限を付与します。

olp schema permission grant <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマの HERE リソースネーム 。
  • 次のいずれかの受取人 :
    • --group <groupID1 groupID2 ...> スキーマアクセスを許可するグループ ID のリスト。スペースで区切ります。
    • --user <userID1 userID2 ...> スキーマへのアクセス権を付与するユーザー ID のリスト。スペースで区切ります。 この情報は .here/credentials.properties 、ファイル、ユーザーのホームディレクトリ、 または自分のプロファイルから見つけることができます。
    • --app <appID1 appID2 ...> スキーマアクセスを許可するアプリケーション ID のリスト。スペースで区切ります。
  • 次のいずれかの権限が必要です。
    • --read スキーマへの読み取りアクセス権を付与します。
    • --modify スキーマへの変更アクセス権を付与します。
    • --share スキーマへの共有アクセス権を付与します。

注

対応する、、 --group、 --user または --app の --read --modify --share パラメータを少なくとも 1 つ指定する必要 があります。

オプションのパラメータ :

  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。

注

このコマンドは、プロジェクト外で作成されたスキーマにのみ適用されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

Linux
窓
olp schema permission grant hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 \
   --group GROUP-example-group-id --read --modify
olp schema permission grant hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 ^
   --group GROUP-example-group-id --read --modify

hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 上記の例のスキーマ HERE リソースネーム は、独自のスキーマの HERE リソースネーム を渡すプレースホルダーとして機能します。

スキーマ権限の削除

スキーマですべてのアクションを実行する権限を削除します。

olp schema permission revoke <schema HRN> [command options]

必須パラメータ :

  • <schema HRN> スキーマの HERE リソースネーム 。
  • 次のいずれかの受取人 :
    • --app <appID1 appID2 ...> スキーマアクセス権を削除するアプリケーション ID のリスト。スペースで区切ります。
    • --user <userID1 userID2 ...> スキーマアクセス権を削除するユーザー ID のリスト。スペースで区切ります。 この情報は .here/credentials.properties 、ファイル、ユーザーのホームディレクトリ、 または自分のプロファイルから見つけることができます。
    • --group <groupID1 groupID2 ...> スキーマアクセス権を削除するグループ ID のリスト。スペースで区切ります。
  • 次のいずれかの権限が必要です。
    • --read スキーマへの読み取りアクセス権を削除します。
    • --modify スキーマへの変更アクセス権を削除します。
    • --share スキーマへの共有アクセス権を削除します。

注

対応する、、 --group、 --user または --app の --read --modify --share パラメータを少なくとも 1 つ指定する必要 があります。

オプションのパラメータ :

  • --credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。

注

次のコマンドは、プロジェクト外で作成されたスキーマにのみ適用されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

Linux
窓
olp schema permission revoke hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 \
   --group GROUP-example-group-id --read --modify --share
olp schema permission revoke hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 ^
   --group GROUP-example-group-id --read --modify --share

レスポンス :


Revoked read, modify, share access for a group GROUP-example-group-id to the schema hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0

hrn:here:schema::org:com.here.example:test_schema_v1:1.0.0 上記の例のスキーマ HERE リソースネーム は、独自のスキーマの HERE リソースネーム を渡すプレースホルダーとして機能します。

スキーマ が生成されます

Maven プロジェクトの新しいスキーマ を生成します。

olp schema generate <group ID> <artifact ID> [command parameters]

必須パラメータ :

  • <group ID> スキーマ のグループ ID 。
  • <artifact ID> ルートアーティファクトのアーティファクト ID

オプションのパラメータ :

  • --archetype-version <archetype version> スキーマ の生成に使用されるスキーマ 原型のバージョン。 最新バージョンはデフォルトで設定されています。
  • --description <schema description> スキーマ の概要。 加工品の値はデフォルトで設定されています
  • --documentation <URL|path to documentation file> ドキュメントへの URL 、またはマークダウンファイルへのパス。
  • --layer-schema <true|false> false スキーマ が他のスキーマのコンポーネントとしてのみ使用される場合に、このオプションをに設定します。 デフォルト値はです true。
  • --major-version <major version> スキーマ のアーティファクト ID の接尾辞として使用されるメジャーバージョン 指定しない 1 場合は、バージョンが使用されます。
  • --mvn-options <Maven options> Maven 文字列で提供されるオプション。 Maven デフォルトでは、オプションは提供されていません。
  • --mvn-output から Maven コンソールへの出力のリダイレクトが設定されているかどうかを示すパラメータ。 デフォルト値はです false。
  • --name <schema name> スキーマ の名前。 原型からの値はデフォルトで設定されています。
  • --output <path to output directory> 生成されたスキーマ ソースコードを含むストアへのパス。 現在のディレクトリがデフォルトで使用されます。
  • --source <path to directory or file> スキーマ メッセージが含まれているフォルダまたはファイルへのパス。
  • --type <proto|json> 生成するスキーマ のタイプを指定します。 デフォルト値はです json。
  • --version <version> 生成するスキーマ のバージョンを指定します。 デフォルト値はです 1.0.0。
  • --credentials <path to credentials file> コマンドで使用する資格情報 ファイルの名前。 資格情報 ファイルは、 プラットフォーム ポータル とは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet スキーマ が生成されたフォルダを表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドを実行すると、com.here.test グループと test_schema アーティファクト ID を含むスキーマが生成されます。


olp schema generate com.here.test test_schema

出力 :


Schema has been successfully generated in /home/user/test_schema

スキーマ パッケージ

生成されたスキーマ プロジェクトを検証してビルドします。

olp schema package [command parameters]

オプションのパラメータ :

  • --input <path to input directory> 生成されたスキーマ ソースコードのストレージへのパス。 現在のディレクトリがデフォルトで使用されます。
  • --mvn-options <Maven options> Maven 文字列で提供されるオプション。 Maven デフォルトでは、オプションは提供されていません。
  • --mvn-output から Maven コンソールへの出力のリダイレクトが設定されているかどうかを示すパラメータ。 デフォルト値はです false。
  • --credentials <path to credentials file> コマンドで使用する資格情報 ファイルの名前。 資格情報 ファイルは、 プラットフォーム ポータル とは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet 空の出力を追加情報なしで表示します。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンドは ~/Desktop/test_schema/ 、フォルダーにあるビルド生成のスキーマ プロジェクトを示しています。


olp schema package --input `~/Desktop/test_schema/`

出力 :


Schema has been packaged successfully

スキーマ PUT

スキーマ を確認してプラットフォーム にアップロードします。

olp schema put [command parameters]

オプションのパラメータ :

  • --input <path to schema directory> 生成されたスキーマ のディレクトリ。 このパラメータを使用しない場合、デフォルトのディレクトリが現在のディレクトリとして設定されます。
  • --mvn-options <Maven options> Maven 文字列で提供されるオプション。 Maven デフォルトでは、オプションは提供されていません。
  • --mvn-output から Maven コンソールへの出力のリダイレクトが設定されているかどうかを示すパラメータ。 デフォルト値はです false。
  • --credentials <path to credentials file> コマンドで使用する資格情報 ファイルの名前。 資格情報 ファイルは、 プラットフォーム ポータル とは別にダウンロードされます。
  • --profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
  • --quiet スキーマ が生成されたフォルダを表示します。
  • --scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。

例 :

以下のコマンド /home/user/test_schemaは、ディレクトリに生成されたスキーマ をアップロードします。


olp schema put --input=/home/user/test_schema

出力 :


Schema hrn:here:schema::org:com.here.test:test_schema_v1:1.0.0 has been created
For more information, use the 'olp schema show' command

「」に一致する結果は 件です

    「」に一致する結果はありません