カタログレイヤー
OLP CLI は、次のものをサポートしています。
- カタログにレイヤーを追加します
- カタログ内のレイヤーを表示します
- カタログ内のレイヤーを更新します
- カタログ内のレイヤーを削除します
- カタログ内のレイヤーを検査します
カタログレイヤーが追加されました
指定したレイヤーをカタログに追加します。
olp catalog layer add <catalog HRN> <layer ID> <layer name> <layer type> \
--summary <layer summary> --description <layer description> [command options]
olp catalog layer add <catalog HRN> <layer ID> <layer name> <layer type> ^
--summary <layer summary> --description <layer description> [command options]
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。 -
<layer ID>
追加するレイヤーの ID 。 -
<layer name>
レイヤーの人間が読める名前。 <layer type>
レイヤーのタイプ。 --versioned
、 --volatile
、 --stream
、 --index
、 --objectstore
または --interactivemap
。 -
--summary <layer summary>
レイヤーの内容を 1 行で要約します。 -
--description <layer description>
カタログおよびその内容の詳細な説明。 説明は引用符で囲んでください。
インデックス レイヤーの必須パラメータ :
-
--index-definitions <index-key-name:index-key-type[:duration][:zoom-level]>
レイヤーのインデックス定義 : -
index-key-name
は、クエリー API でクエリー述語を表現するために使用される名前です。 -
index-key-type
サポートされているキーのタイプについて説明します。 指定できる値は bool
、int
、 string
、 heretile
、または timewindow
です。 duration はタイルスライス timewindow
キーの長さを表し ます。 zoom-level はheretile
ズーム レベルを表します。
オプションのパラメータ :
-
--content-type <layer data type>
レイヤーのコンテンツタイプ。 application/vnd.geo+json
および text/plain
など。 デフォルト値はです application/x-protobuf
。 -
--content-encoding <encoding type>
など、レイヤーのコンテンツエンコード。 gzip
このパラメータを指定すると、レイヤー内のすべてのデータが指定したアルゴリズムで圧縮されます。 デフォルト値はです Uncompressed
。つまり、圧縮は行われません。 -
--tags <tag1 tag2 ..>
検索の検索に使用されるカタログキーワード。 -
--schema <schema HRN>
このレイヤーのデータスキーマの HERE リソースネーム 。 -
--billing-tags <tag1 tag2 ...>
請求タグのリスト。 検索の検出に使用されます。 -
--coverage <code1 code2 ...>
国および地域の ISO 3166 2 文字のコードのリスト。 オプションで、ドイツ DE
、ポーランド PL
、香港 CN-HK
、中国などのサブディビジョンに最大 3 文字のコードを付けます。 これらのコードはスペースで区切る必要があります。 -
--quiet
空の出力を追加情報なしで表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
ボラタイル レイヤーのオプションのパラメータ :
-
--max-memory-policy
レイヤーの削除ポリシー。 -
--data-redundancy <single-instance|multi-instance>
レイヤーのデータ冗長性。 単一インスタンスのレイヤーにはデータの冗長性がありませんが、複数インスタンスのレイヤーには冗長性があります。 データ冗長性は、揮発性レイヤーにのみ固有であり、単一リージョン内のデータ冗長性を参照します。 コストの考慮事項の詳細について は、「データの制限とコスト」を参照してください。 -
--storage-capacity <size in MB>
メガバイト単位で指定されたレイヤーのストレージ容量。増分ステップは 100 ( 100 、 500 、 600 、 2000 など)です。 - 最小値 : 100 MB ( 100 ) ;
- 最大値 : 21 GB (21000)
-
--ttl
レイヤーの存続可能時間または有効期限 ( ミリ秒 ) 。 - 最大値 : 7 日 (604800000 ms);
- 最小値 : 1 分( 60000 ms ) ;
- デフォルト値 : 1 時間 (3600000 ミリ秒 ) 。
-
--digest <md5|sha-1|sha-256>
レイヤーのチェックサムの計算に使用するダイジェストアルゴリズム。 指定できる値は md5
、、 sha-1
、 sha-256
です。 -
--partitioning <generic|heretile[:tilelevel1,tilelevel2...]>
レイヤーのパーティション分割方式。 heretile
またはgeneric
のいずれか です。 で heretile
は tile levels
、などのコンマで区切って指定でき heretile:level1,level2
ます。 プラットフォームは、 1 ~ 15 のタイルレベルをサポートしています。 デフォルト値はです generic
。 --crc <CRC-32C>
巡回冗長検査の計算に使用されるアルゴリズム。現在サポート されているのは <CRC-32C>
のみです(大文字と小文字は区別されません。crc-32c
を使用できます)。
ストリーム レイヤーのオプションのパラメータ :
必要なストリーミングレイヤーのスケールを定義する 3 つのプロパティをすべて指定することをお勧めします。
--data-in <size><KB|MB>
--data-out <size><KB|MB>
-
--parallelization <number of Kafka partitions>
。
--data-in
と --data-out
またはのいずれかの組み合わせ --parallelization
が必要です。
-
--data-in <size><KB|MB>
レイヤー内の受信データの最大スループット。 - 最大値 : 32 MB (最大 32,800 kbps 、または最も近い 100 分の 1 に切り上げられた 32,768 kbps )
- 最小値 : 100KB ( 100 kbps の倍数にのみ設定可能)
- デフォルト値 : スケール パラメータが設定されていない場合は 1MB 、設定されていない場合は HERE platform によって計算されます。
- 単位の値を省略すると、 MB がデフォルトで使用されます。
-
--data-out <size><KB|MB>
レイヤー内の送信データの最大スループット。
- 最大値 : 64MB (65 、 500 kbps 以下、または 65,536 kbps 以下の数値を四捨五入して 100 番目に近い値 )
- 最小値 : 100KB ( 100 kbps の倍数にのみ設定可能)
- デフォルト値 : 4 MB ( スケール パラメータが設定されていない場合 ) 。設定されていない場合は、 HERE platform によって計算されます。
- 単位の値を省略すると、 MB がデフォルトで使用されます。
-
--parallelization <number of Kafka partitions>
ストリーム レイヤー用の Kafka パーティションの数。 このパラメータが設定されている場合は、 --data-in <size><KB|MB>
および --data-out <size><KB|MB>
のパラメータを省略でき、デフォルト値が使用されます。
- 最大値 : 32 ;
- 最小値 : 1 ;
- デフォルト値 : スケール パラメータが設定されていない場合は 1 、設定されていない場合は HERE platform によって計算されます。
-
--ttl <time in ms>
レイヤーの存続可能時間または有効期限 ( ミリ秒 ) 。 - 最大値 : 3 日( 259200000 ms ) ;
- 最小値 : 10 分( 600000 ms ) ;
- デフォルト値 : 1 時間 (3600000 ミリ秒 ) 。
ストリーム レイヤーパラメータの詳細については 、データ クライアント ライブラリ開発者ガイドを参照してください。
バージョン付レイヤーのオプションのパラメータ :
-
--digest <md5|sha-1|sha-256>
レイヤーのチェックサムの計算に使用するダイジェストアルゴリズム。 指定できる値は md5
、、 sha-1
、または sha-256
です。 -
--partitioning <generic|heretile[:tilelevel1,tilelevel2...]>
レイヤーのパーティション分割方式。 heretile
またはgeneric
のいずれか です。 heretile
では、 heretile:level1,level2
などのコンマで区切って tile levels
指定できます。 プラットフォームは、 1 ~ 15 のタイルレベルをサポートしています。 デフォルト値はです generic
。 --crc <CRC-32C>
巡回冗長検査の計算に使用されるアルゴリズム。現在サポート されているのは <CRC-32C>
のみです(大文字と小文字は区別されません。crc-32c
を使用できます)。
インデックス レイヤーのオプションのパラメータ :
-
--ttl <time in dd, mm, yy>
インデックス レイヤー内のデータの存続可能時間または有効期限。 指定できる値は、 7.days
、 15.days
、 1.month
、 2.months
、 3.months
、 4.months
、 5.months
、 6.months
、 1.year
、 1.5.years
、 2.years
、および unlimited
。 デフォルトの TTL 設定はです 7.days
。 --crc <CRC-32C>
巡回冗長検査の計算に使用されるアルゴリズム。現在サポート されているのは <CRC-32C>
のみです(大文字と小文字は区別されません。crc-32c
を使用できます)。 -
--digest <md5|sha-1|sha-256>
レイヤーのチェックサムの計算に使用されるダイジェストアルゴリズム。 指定できる値は md5
、、 sha-1
、 sha-256
です。
インタラクティブマップ レイヤーのオプションのパラメータ :
--searchable-properties
高速検索のためにインデックスを作成するプロパティを含む文字列のリスト。 検索可能なプロパティはいつでも更新できます。 検索可能なプロパティの最大数は 8 です。
例 :
次のコマンドは、 ID new-layer
を持つ versioned
レイヤーを catalog1
に追加します。
olp catalog layer add hrn:here:data::org:catalog1 new-layer new-layer-name \
--versioned --summary "A summary"
olp catalog layer add hrn:here:data::org:catalog1 new-layer new-layer-name ^
--versioned --summary "A summary"
例 :
次のコマンドを実行すると、 md5
ダイジェスト、 heretile
パーティション分割、および tile levels
を含む versioned
レイヤーが catalog1
追加されます。
olp catalog layer add hrn:here:data::org:catalog1 new-layer new-layer-name \
--versioned --partitioning heretile:7,10,14 --digest md5 --summary "A summary"
olp catalog layer add hrn:here:data::org:catalog1 new-layer new-layer-name ^
--versioned --partitioning heretile:7,10,14 --digest md5 --summary "A summary"
カタログレイヤーが表示されます
レイヤーのプロパティを表示します。
olp catalog layer show <catalog HRN> <layer ID> [command options]
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。 -
<layer ID>
表示するレイヤーの ID 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 --json
コマンドの結果を JSON 形式で表示します。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
レイヤーのタイプと そのパーティション分割方式をスペースで区切って表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。
例 :
次のコマンドを実行すると、 test-catalog
内の test-layer
プロパティが表示されます。
olp catalog layer show hrn:here:data::org:test-catalog test-layer --json
注
olp catalog layer show --json
コマンド出力に hrn
は、 設定 API 応答に存在するフィールドは含まれません。
出力 :
{
"summary": "Summary",
"volume": { "volumeType": "durable" },
"layerType": "versioned",
"billingTags": [],
"crc": "CRC-32C",
"name": "Test Layer",
"description": "some description",
"partitioningScheme": "generic",
"partitioning": { "scheme": "generic" },
"id": "test-layer",
"contentType": "application/octet-stream",
"tags": []
}
カタログレイヤーの更新
カタログ内の指定したレイヤーを更新します。
olp catalog layer update <catalog HRN> <layer ID> [command options]
警告
回復不能なデータの不整合のリスクがあります
データが含まれているレイヤーのコンテンツタイプ (--content-type
) 、コンテンツエンコード (--content-encoding
) 、またはコンテンツスキーマ定義 (--schema
) を更新すると、回復不能なデータの整合性が失われる可能性があります。 このような変更は、データの下流の消費者に悪影響を与える可能性があります。
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。 -
<layer ID>
更新するレイヤーの ID 。
オプションのパラメータ :
-
--name <layer name>
レイヤーの人間が読める名前。 -
--summary <layer summary>
レイヤーの内容を 1 行で要約します。 -
--description <layer description>
カタログおよびその内容の詳細な説明。 説明は引用符で囲んでください。 -
--tags <tag1 tag2 ...>
検索の検索に使用されるカタログキーワード。 -
--schema <schema HRN>
このレイヤーのデータスキーマの HERE リソースネーム 。 -
--billing-tags <tag1 tag2 ...>
検索の検索に使用される請求タグのリスト。 -
--coverage <code1 code2 ...>
国および地域の ISO 3166 2 文字のコードのリスト。 オプションで、ドイツ DE
、ポーランド PL
、香港 CN-HK
、中国などのサブディビジョンに最大 3 文字のコードを付けます。 これらのコードはスペースで区切る必要があります。 -
--quiet
空の出力を追加情報なしで表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
ストリーム レイヤーのオプションのパラメータ :
-
--ttl
レイヤーの存続可能時間または有効期限 ( ミリ秒 ) 。 - 最大値 : 7 日 (604800000 ms);
- 最小値 : 1 分( 60000 ms ) ;
- デフォルト値 : 1 時間 (3600000 ミリ秒 ) 。
-
--content-type <layer data type>
レイヤーのコンテンツタイプ。 application/vnd.geo+json
および text/plain
など。 デフォルト値はです application/x-protobuf
。 -
--content-encoding <encoding type>
など、レイヤーのコンテンツエンコード。 gzip
このパラメータを指定すると、レイヤー内のすべてのデータが指定したアルゴリズムで圧縮されます。 デフォルト値はです Uncompressed
。つまり、圧縮は行われません。 -
--data-in <size><KB|MB>
レイヤー内の受信データの最大スループット。 - 最大値 : 32 MB (最大 32,800 kbps 、または最も近い 100 分の 1 に切り上げられた 32,768 kbps )
- 最小値 : 100KB ( 100 kbps の倍数にのみ設定可能)
- デフォルト値 : スケール パラメータが設定されていない場合は 1MB 、設定されていない場合は HERE platform によって計算されます。
- 単位の値を省略すると、デフォルトで MB が使用されます。
-
--data-out <size><KB|MB>
レイヤー内の送信データの最大スループット。 - 最大値 : 64MB (65 、 500 kbps 以下、または 65,536 kbps 以下の数値を四捨五入して 100 番目に近い値 )
- 最小値 : 100KB ( 100 kbps の倍数にのみ設定可能)
- デフォルト値 : 4 MB ( スケール パラメータが設定されていない場合 ) 。設定されていない場合は、 HERE platform によって計算されます。
- 単位の値を省略すると、デフォルトで MB が使用されます。
インデックス レイヤーのオプションのパラメータ :
-
--ttl <time in dd, mm, yy>
インデックス レイヤー内のデータの存続可能時間または有効期限。 指定できる値は、 7.days
、 15.days
、 1.month
、 2.months
、 3.months
、 4.months
、 5.months
、 6.months
、 1.year
、 1.5.years
、 2.years
、および unlimited
。 デフォルトの TTL 設定はです 7.days
。 -
--digest <md5|sha-1|sha-256>
レイヤーのチェックサムの計算に使用するダイジェストアルゴリズム。 指定できる値は md5
、、 sha-1
、 sha-256
です。
注
TTL の変更は伝播に最大 24 時間かかることがあります。そのため、新しい TTL の変更が適用される前に、以前の TTL ごとの有効期限の処理中のデータがすべて期限切れになります。
バージョン付レイヤーのオプションのパラメータ :
-
--digest <md5|sha-1|sha-256>
レイヤーのチェックサムの計算に使用するダイジェストアルゴリズム。 指定できる値は md5
、、 sha-1
、 sha-256
です。
注
--digest
パラメータは一度設定すると更新できません。 olp catalog layer add
このパラメータがまたは olp catalog layer update
コマンドにすでに指定されている場合は、変更できません。
インタラクティブマップ レイヤーのオプションのパラメータ :
--searchable-properties
高速検索のためにインデックスを作成するプロパティを含む文字列のリスト。 検索可能なプロパティはいつでも更新できます。 検索可能なプロパティの最大数は 8 です。
例 :
次のコマンドを使用すると、レイヤーの名前が old-layer
から newname
に、タグが tag1
および tag2
に更新されます。
olp catalog layer update hrn:here:data::org:catalog1 old-layer --name newname \
--description "New Description" --tags tag1 tag2
olp catalog layer update hrn:here:data::org:catalog1 old-layer --name newname ^
--description "New Description" --tags tag1 tag2
カタログレイヤーを削除します
カタログ内の指定したストリーム、 volatile 、 index 、 object store 、 interactive map 、またはバージョン付レイヤーを削除します。
olp catalog layer delete <catalog HRN> <layer ID> [command options]
警告
レイヤーを完全に削除すると、そのレイヤーに関連付けられているデータとメタデータの両方が削除され、復元不可能になります。
必須パラメータ :
-
<catalog HRN>
カタログの HERE リソースネーム 。 -
<layer ID>
削除するレイヤーの ID 。
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
例 :
次のコマンドを実行すると、 hrn:here:data::org:catalog1
カタログから some-layer
レイヤーが削除されます。
olp catalog layer delete hrn:here:data::org:catalog1 some-layer
注
- レイヤーを削除すると、そのレイヤーからデータを消費する依存パイプラインが壊れる可能性があります。
- 同じレイヤー ID でバージョン付レイヤーを削除して再作成すると、元のレイヤーが空でないすべてのバージョンが変更されます。 これは、カタログバージョンの不変性に依存するバッチ処理パイプラインに影響を与える可能性があります。 たとえば、マップのコンパイルの使用例では、古い固定バージョンのカタログに基づいて派生マップを再計算したり、変更されたパーティションを正しく処理したりできない場合があります。
- バージョン付レイヤーを削除して再作成する前に HERE 、そのレイヤーが空でないすべてのカタログバージョンを削除して、これらのバージョンのコンテンツが変更されないようにすることをお勧めします。
カタログレイヤーの検査
外部ブラウザを開き、 プラットフォーム ポータル のレイヤー検査ページに移動します。 レイヤーが適切に設定されている場合、データは視覚的に( HERE Tile レイヤーのみ)検査でき、構造的にも検査できます。 詳細については 、データ インスペクター ライブラリ のマニュアルを参照してください。
カタログにアクセスできない場合、または指定したレイヤーが存在しない場合、コマンドは失敗します。
olp catalog layer inspect <catalog HRN> <layer ID> [command options]
オプションのパラメータ :
-
--credentials <path to credentials file>
コマンドで使用する資格情報ファイルの名前。 資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。 -
--profile <profile name>
olpcli.ini
ファイルから使用する資格情報プロファイルの名前。 -
--quiet
空の出力を追加情報なしで表示します。 -
--scope <project HRN>
リクエストのスコープとして使用するプロジェクト HERE リソースネーム を指定します。 で指定された値 --scope
は here.token.scope
、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。
注
olp catalog layer inspect
このコマンドは、カタログがアプリからアクセス可能かどうかをアプリの権限に従って確認します。 ただし、ポータルでカタログレイヤーを表示するには、ユーザーもカタログに対する読み取り権限を持っている必要があります。 - 現在、インタラクティブマップ レイヤーはカタログレイヤーインスペクターではサポートされていません。
資格情報 およびプロファイルの使用方法の詳細について は、「資格情報 の設定」を参照してください。