パイプラインバージョン

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

パイプラインバージョンを作成します
パイプラインバージョンをアクティブ化します
パイプラインバージョンをアップグレードします
パイプラインバージョンを一時停止します
パイプラインバージョンを再開します
パイプラインのバージョンを一覧表示します
パイプラインバージョンを表示します
パイプラインバージョンを削除します
パイプラインバージョンをキャンセルvます
パイプラインバージョンを非アクティブ化します
パイプラインのバージョンを待ってください
パイプラインバージョンをコピーします
パイプラインバージョンのログ設定を取得します
パイプラインバージョンのログ設定を設定します

パイプラインバージョンが作成されました

指定したパイプラインのパイプラインバージョンを作成します。

Linux

窓

olp pipeline version create <name> <pipeline ID> <template ID> \
   <pipeline-config.conf> [command options]

olp pipeline version create <name> <pipeline ID> <template ID> ^
   <pipeline-config.conf> [command options]

必須パラメータ :

<name> バージョンの名前。このパラメータの長さは 3 ～ 64 文字である必要があります。
<pipeline ID> パイプラインの ID 。
<template ID> パイプラインテンプレートの ID 。
<pipeline-config.conf> 指定した出力および入力カタログを含む設定ファイル。

通常 input-catalogs 、このパラメーターは、パイプラインの 1 つ以上の入力カタログを指定します。入力カタログごとに、カタログの HERE リソースネームとともに固定 ID が提供されます。

ストリームバージョンおよびバッチパイプラインバージョンの入力と出力の両方に同じカタログを使用できます。

パイプラインがプロジェクト範囲にある場合は、プロジェクトでテンプレートを使用するか、またはプロジェクトにリンクしてバージョンを作成できます。プロジェクトにリンクできるパイプラインテンプレートを検索するに olp resource link availability create は、コマンドを使用します。

pipeline-config.conf 次のファイルの抜粋は、カタログの指定方法を示しています。


  pipeline.config {
      output-catalog { hrn = "hrn:here:data::org:example-output" }
      input-catalogs {
          catalogExample1 { hrn = "hrn:here:data::org:example1" }
          catalogExample2 { hrn = "hrn:here:data::org:example2" }
          catalogExample3 { hrn = "hrn:here:data::org:example3" }
      }
  }

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

--supervisor-units <size in units> スーパーバイザノードのサイズ（ 1 ～ 15 単位）。パイプラインテンプレートにはデフォルト値が設定されています。
--supervisor-units-profile <resource profile ID> スーパーバイザユニットに要求されたリソースプロファイルの ID 。パイプラインテンプレートにはデフォルト値が設定されています。現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。
--workers <number of workers> 作業者数。パイプラインテンプレートにはデフォルト値が設定されています。
--worker-units <size in units> ワーカーノードのサイズ (1 ～ 15 単位 ) 。パイプラインテンプレートにはデフォルト値が設定されています。
--worker-units-profile <resource profile ID> 作業者ユニットに要求されたリソースプロファイルの ID 。パイプラインテンプレートにはデフォルト値が設定されています。現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。
--billing-tag <tag> コスト割り当てのタグ。課金レコードをグループ化するために使用されます。
--runtime-config <key1=value1 key2=value2 ...> パイプラインアプリケーションのキー値設定のカスタムマップ。提供 HERE されているランタイム設定値は、親パイプラインテンプレートの任意のデフォルトのランタイム設定に追加されます。ランタイム設定の HERE は、同じキーを使用している親パイプラインテンプレートのデフォルトを上書きします。
--stream-config <key1=value1 key2=value2 ...> ストリームパイプラインバージョンのキー値設定のカスタムマップ。このパラメータを使用 stream-2.x.x すると、キーと値のペアを渡して、および新しいパイプラインのカスタム設定を指定できます。このオプションでサポートされているすべてのパラメータについては、「ストリームの設定」を参照してください。

注
--runtime-config パラメーターおよび --stream-config パラメーターの値は、のよう "key1=value1 key2=value2"に二重引用符で囲む必要があります。値にスペースが含まれている場合 "key1='some value1' key2=value2"は、のように一重引用符で囲む必要があります。 \n スプリッタのパラメータ値も許容範囲内であることを考慮してください。例 : "key1='some value1'\nkey2=value2\n"
--multi-region ダウンタイムを最小限に抑える必要があるパイプラインの場合、このフラグを使用してパイプラインバージョンの複数リージョンの設定を有効にし、プライマリリージョンに障害が発生するとパイプラインバージョンが自動的にセカンダリリージョンに転送されるようにします。パイプラインの複数リージョン機能の詳細については、「パイプラインの複数リージョンの設定を有効にする」を参照してください
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json パイプラインバージョンを JSON 形式で表示します。
--quiet パイプラインバージョン ID を表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

廃止されたオプションのパラメータ :

--with-scheduler 入力カタログの変更時にパイプラインバージョンを実行するようにスケジューラを設定します。設定されていない場合、パイプラインバージョンはアクティブ化後ただちに実行されます。このパラメータは、ストリームパイプラインバージョンには適用されません。 非推奨です。

パイプラインバージョンの実行モードを変更するための新しいパラメータ --schedule が olp pipeline version activate コマンドに追加されました。

注

HERE platform では、別のアプリを使用してパイプラインをアップグレードできるように、「 Run As 」がサポートされています。 OLP CLI は常に、資格情報ファイルの app_id を使用してパイプラインをアップグレードします。別 の app_id を使用してパイプラインをアップグレードする場合は、別の資格情報ファイルを使用してください。

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

パイプライン設定の詳細については、「パイプライン設定」を参照してください。

例 :

次のコマンドを使用すると、指定した名前、パイプライン ID 、パイプラインテンプレート ID 、および設定を使用してパイプラインバージョンが作成されます。

Linux

窓

olp pipeline version create version-name example-pipeline-id \
   example-pipeline-template-id /user/data/pipeline-config.conf

olp pipeline version create version-name example-pipeline-id ^
   example-pipeline-template-id /user/data/pipeline-config.conf

パイプラインバージョンがアクティブ化されました

指定したパイプラインバージョンをアクティブ化し、アクティブ化操作が完了するまで待機します。操作が成功すると、パイプラインステータスは scheduled またはのいずれかになり runningます。

olp pipeline version activate <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

--input-catalogs <input catalog specs...> パイプラインバージョンのジョブをオンデマンドで実行するための、入力カタログの特定のバージョンおよび実行モード。このパラメータは、正確なバージョンの入力カタログで実行する必要があるバッチパイプラインバージョンをアクティブ化する場合に適用されます ( pipeline-config.conf ファイルで定義され、スケジューラを使用せずに現在実行モードで処理されるタイプ ( つまり、 --schedule パラメータを none に設定 ) ) 。 HERE platform バージョンの実行構成を API パイプラインパイプラインに展開する前に、特定のカタログバージョンでローカルにローカルでテストおよび微調整するために--input-catalogsを使用することをお勧めします。詳細については、 SDK for Java & Scala アーカイブに含まれているデータプロセッシングライブラリの例を参照してください。

このパラメータには、次のいずれかを指定できます。
- pipeline-job.conf ファイルへのパス。
- catalog-id:processing-type:version[:sine-version] 形式の入力カタログバージョンおよび処理タイプ。ここで、 sine-version は changes 処理タイプにのみ必要です。 catalog-id は pipeline-config.conf とpipeline-job.confの両方で使用される固定 ID です。 processing-type では、最後の正常な実行以降に各入力カタログで変更された内容について説明します。可能な値は、 no_changes、 changes、 reprocess です。
--input-catalogs が渡されない場合 reprocess 、最新の入力カタログバージョンが自動的に識別され、処理タイプが適用されます。
--schedule <data-change|time:<cron-expression>|none> バッチパイプラインバージョンの実行モード。 data-change 値は、入力カタログの変更に基づいて実行されるようにパイプラインバージョンを設定します。 値 none を指定すると、パイプラインバージョンがただちに実行されるように設定されます。このパラメータを使用しない場合、現在の実行モードがアクティブ化に使用されます。 pipeline version show コマンドを使用して、現在のモードを確認します。このパラメータは、ストリームパイプラインバージョンには適用されません。この値 time:<cron-expression>は、 UNIX cron 形式の cron 式で定義されたスケジュールに基づいて実行されるようにパイプラインバージョンを設定します。
--processing <changes|force> 時間ベースのスケジュールの処理タイプ。 変更内容 ( デフォルト値 ) を使用して、 cron スケジュールで実行する前に入力カタログで変更内容を最初に確認します。カタログのバージョンに変更がある場合、システムはカタログのバージョンでジョブを送信します。 force を使用する と、入力カタログの変更を確認せずに、指定した cron スケジュールでパイプラインバージョンを実行できます。 --input-catalogs が提供されている場合、システムは、入力内容から提供されたカタログバージョンを使用して、実行ごとにジョブを送信します。 --input-catalogs が指定されていない場合、システムはカタログバージョンなしでジョブを送信します。

注
処理パラメータは、の時間ベースのスケジューリングにのみ適用 --schedule time:cron-expressionされます。
--high-availability プライマリ JobManager に障害が発生した場合に、セカンダリ JobManager を使用して、 Flink ジョブが失敗したストリームパイプライン JobManager から自動的に復旧できるようにするフラグ。この機能を使用すると、追加のリソースに追加のコストが発生します。デフォルト false では、パラメータ値はで、ストリームパイプラインジョブには 1 つのジョブマネージャーが使用されます。
--snapshot-id ストリーミングパイプラインのスナップショット ID 。指定したスナップショットから新しいジョブを再開します。詳細については、 olp pipeline snapshot コマンドを参照してください。

注
--snapshot-id このパラメータは、ランタイム環境 stream-5.0 以降を使用するストリーミングパイプラインにのみ適用されます。
--with-latest-checkpoint 最新のチェックポイントからストリーミングパイプラインを開始するフラグ。チェックポイントが見つからない場合 pipeline version activate 、操作は失敗します。

注
--with-latest-checkpoint このパラメータは、ランタイム環境 stream-5.0 以降を使用するストリーミングパイプラインにのみ適用されます。
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json アクティブ化されたパイプラインバージョンの内容を JSON 形式で表示します。
--quiet パイプラインバージョンの状態を表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

警告

下位互換性

非推奨の --with-scheduler パラメーターを使用してバッチパイプラインバージョンを作成し、 --schedule パラメーターなしでアクティブ化した場合、予期したとおりに動作し続けます。ただし --schedule none 、アクティブ化中にオプションを使用すると、パイプラインバージョンがただちに（オンデマンドで）実行されるように再設定されます。入力カタログの変更に基づいてモードを実行に戻すには、 --schedule data-change を次回のアクティブ化に使用するか、 --schedule time:<cron-expression> を使用して時間ベースのスケジュールでパイプラインバージョンを実行します。

注

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

例 :

次のコマンドを使用すると、指定したパイプラインバージョンがアクティブ化されます

olp pipeline version activate example-pipeline-id example-version-id

--with-scheduler パラメータを指定せずにパイプラインバージョンが作成された場合、パイプラインバージョンの実行がただちに開始され、パイプラインログ URL が返されて、 Splunk のパイプラインログへのリンクが表示されます。

--with-scheduler パラメータを使用してパイプラインバージョンが作成された場合、入力カタログの変更時にスケジューラがトリガーされたときにパイプラインバージョンが実行されます。

`--input-catalogs` で `pipeline-job.conf` 使用しています

pipeline-job.conf ファイルの例を次に示します。

pipeline.job.catalog-versions {
    output-catalog { base-version = 1 }
    input-catalogs {
        catalogExample1 {
            processing-type = "no_changes"
            version = 1
        }
        catalogExample2 {
            processing-type = "no_changes"
            version = 1
        }
    }
}

詳細については、「パイプラインプロセスとのインターフェイス」を参照してください。

パイプラインバージョンのアップグレード

指定したパイプラインバージョンを別のパイプラインバージョンにアップグレードし、操作が完了するまで待機します。

Linux

窓

olp pipeline version upgrade <pipeline ID> --to <pipeline version ID to upgrade to> \
   --from <pipeline version ID to upgrade from> [command option]

olp pipeline version upgrade <pipeline ID> --to <pipeline version ID to upgrade to> ^
   --from <pipeline version ID to upgrade from> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
--to <pipeline version ID to upgrade to> アップグレード先のパイプラインバージョンの ID 。
--from <pipeline version ID to upgrade from> アップグレード元のパイプラインバージョンの ID 。

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

--high-availability プライマリ JobManager に障害が発生した場合に、セカンダリ JobManager を使用して、 Flink ジョブが失敗したストリームパイプライン JobManager から自動的に復旧できるようにするフラグ。この機能を使用すると、追加のリソースに追加のコストが発生します。デフォルト false では、このパラメータはで、ストリームパイプラインジョブには 1 つのジョブマネージャーが使用されます。
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json アップグレードされたパイプラインバージョンの内容を JSON 形式で表示します。
--quiet パイプラインバージョンの状態を表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

注

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

例 :

次のコマンドを使用すると、パイプラインバージョンが指定したバージョン ID から新しいバージョン ID にアップグレードされます。

Linux

窓

olp pipeline version upgrade example-pipeline-id --to example-new-pipeline-version-id \
   --from example-old-pipeline-version-id

olp pipeline version upgrade example-pipeline-id --to example-new-pipeline-version-id ^
   --from example-old-pipeline-version-id

パイプラインバージョンの一時停止

running 状態にあった指定のパイプラインバージョンを一時停止します。一時停止操作は、ストリームバージョンとバッチパイプラインバージョンでは異なるパターンに従います。詳細については、「パイプラインの実行」を参照してください。

olp pipeline version pause <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

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

例 :

次のコマンドを使用すると、指定したパイプラインバージョンが一時停止され

olp pipeline version pause example-pipeline-id example-pipeline-version-id

パイプラインのバージョンが再開されます

指定した一時停止したパイプラインバージョンを再開します。可能であれば、ストリームパイプラインバージョンが一時停止した場所から再開されます。新しいジョブを処理できるようになった場合、およびそのジョブを処理できるようになった場合、バッチパイプラインバージョンが再開されます。

olp pipeline version resume <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

--high-availability プライマリ JobManager に障害が発生した場合に、セカンダリ JobManager を使用して、 Flink ジョブが失敗したストリームパイプライン JobManager から自動的に復旧できるようにするフラグ。この機能を使用すると、追加のリソースに追加のコストが発生します。デフォルト false では、このパラメータはで、ストリームパイプラインジョブには 1 つのジョブマネージャーが使用されます。
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json 再開されたパイプラインバージョンの内容を JSON 形式で表示します。
--quiet パイプラインバージョンの状態を表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

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

例 :

次のコマンドを実行すると、指定したパイプラインバージョンが再開されます。

olp pipeline version resume example-pipeline-id example-pipeline-version-id

パイプラインバージョンリスト

指定したパイプライン ID に属するすべてのパイプラインバージョンを一覧表示します。

olp pipeline version list <pipeline ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。

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

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

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

例 :

次のコマンドは、指定したパイプラインに属するすべてのバージョンを一覧表示します。

olp pipeline version list f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 --json

出力 :


{"pipelineVersions": [{
    "multiRegionEnabled": false,
    "outputCatalogHRN": "hrn:here:data::org:test-catalog",
    "billingTag": null,
    "created": "2018-03-01T15:21:59.145Z",
    "versionNumber": 1,
    "clusterConfiguration": {
        "workerResourceProfileId": "HS1B",
        "supervisorResourceProfileId": "HS1B",
        "supervisorUnits": 1,
        "workerUnits": 1,
        "workers": 1
    },
    "name": "Version 1",
    "customRuntimeConfiguration": "",
    "schedulerConfiguration": {
        "catalogTriggerOptions": null,
        "timeTriggerOptions": {
            "cronJobExpression": "0 1 * * *",
            "processingType": "changes",
        }
    },
    "streamConfiguration": {"taskmanager.numberOfTaskSlots": 2},
    "id": "d77f288e-2c89-4c94-b4ba-79fbd1e26e79",
    "state": "ready",
    "pipelineTemplateId": "5c0660a3-0fb4-4f35-bcd0-be6ce25075f6",
    "loggingUrl": null,
    "updated": "2018-03-01T15:25:34.591Z",
    "inputCatalogs": {"input":
    "hrn:here:data::org:here-optimized-map-for-location-libraries-na-weu-1"}
}]}

パイプラインバージョンが表示されます

指定したパイプラインバージョンに関するすべての情報を表示します。

olp pipeline version show <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

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

例 :

次のコマンドを実行すると、指定したパイプラインバージョンの情報が表示されます。

Linux

窓

olp pipeline version show f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 \
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json

olp pipeline version show f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 ^
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json

出力 :


{
    "multiRegionEnabled": false,
    "outputCatalogHRN": "hrn:here:data::org:test-catalog",
    "billingTag": null,
    "created": "2018-03-01T15:21:59.145Z",
    "versionNumber": 1,
    "clusterConfiguration": {
        "workerResourceProfileId": "HS1B",
        "supervisorResourceProfileId": "HS1B",
        "supervisorUnits": 1,
        "workerUnits": 1,
        "workers": 1
    },
    "name": "v1",
    "highAvailability": false,
    "customRuntimeConfiguration": "",
    "schedulerConfiguration": {
        "catalogTriggerOptions": null,
        "timeTriggerOptions": {
            "cronJobExpression": "0 1 * * *",
            "processingType": "changes",
        }
    },
    "nextJobAttempt": "2019-11-05T01:45:20Z"
    "streamConfiguration": {"taskmanager.numberOfTaskSlots": 2},
    "id": "d77f288e-2c89-4c94-b4ba-79fbd1e26e79",
    "state": "ready",
    "pipelineTemplateId": "5c0660a3-0fb4-4f35-bcd0-be6ce25075f6",
    "loggingUrl": null,
    "updated": "2018-03-01T15:25:34.591Z",
    "inputCatalogs": {"input":
    "hrn:here:data::org:here-optimized-map-for-location-libraries-na-weu-1"}
}

詳細出力では、 schedule フィールドが schedulerConfiguration フィールドに置き換えられ、、 none、 data-change、 <cron-expression> などの人間が読める値がレポートされます。 next run attempt このフィールドには、時間ベースのスケジュール設定でパイプラインバージョンの次のジョブが実行される日時が表示されます。

注

高可用性

olp pipeline version show コマンドの冗長出力では、パイプラインバージョンが --high-availability アクティブ化、再開、またはフラグ付きでアップグレードされ、ステータス running またはのジョブがある場合、高可用性ステータスが true として表示 startingされます。

パイプラインバージョンが削除されました

指定したパイプラインバージョンが ready 状態にある場合、そのパイプラインバージョンを削除します。つまり、 running または paused パイプラインを削除するには、まずキャンセルする必要があります。

olp pipeline version delete <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

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

例 :

次のコマンドを実行すると、指定したパイプラインバージョンが削除されます。

olp pipeline version delete example-pipeline-id example-pipeline-version-id

パイプラインバージョンがキャンセルされました

指定した実行中のパイプラインバージョンと、そのパイプラインバージョンにスケジュールされている今後のすべてのジョブをキャンセルします。

olp pipeline version cancel <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

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

例 :

以下のコマンドを実行すると、指定したパイプラインバージョンがキャンセルされます。

olp pipeline version cancel example-pipeline-id example-pipeline-version-id

パイプラインバージョン非アクティブ化

指定されたアクティブ化されたパイプラインバージョンを非アクティブ化し、操作が完了するまで待機します。

olp pipeline version deactivate <pipeline ID> <pipeline version ID> [command option]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

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

例 :

以下のコマンドを使用すると、指定したパイプラインバージョンが非アクティブ化され

olp pipeline version deactivate example-pipeline-id example-pipeline-version-id

パイプラインバージョンの待機中です

パイプラインバージョンが指定されたジョブ状態に達するまで待機します。パイプラインバージョンが ready または paused 状態の場合、コマンドはタイムアウトを待機しません。代わりに、ジョブの状態に達したことを確認します。

Linux

窓

olp pipeline version wait <pipeline ID> <pipeline version ID> \
   --job-state=completed [command options]

olp pipeline version wait <pipeline ID> <pipeline version ID> ^
   --job-state=completed [command options]

ジョブの状態に達すると、パイプラインジョブ情報が表示されます。それ以外の場合は、エラーメッセージが表示されます。

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

--job-state <running|completed|failed|canceled> パイプラインバージョンのジョブ状態。指定しない場合、デフォルトはです completed。
--timeout <duration in seconds> タイムアウト時間 ( 秒 ) 。指定しない場合、デフォルトはです 3600。
--no-error state not reached timeout エラーを上書きするには、このフラグを設定します。
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json コマンドが成功した場合、パイプラインバージョンジョブを JSON 形式で表示します。
--quiet 空の出力を追加情報なしで表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

詳細については、パイプライン Statesを参照してください。

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

例 :

以下のコマンドは、パイプラインジョブが完了するまで待機します。

Linux

窓

olp pipeline version wait <pipeline ID> <pipeline version ID> \
   --job-state=completed --json

olp pipeline version wait <pipeline ID> <pipeline version ID> ^
   --job-state=completed --json

出力 :

{
  "catalogVersions": null,
  "created": "2018-03-01T15:23:04.618Z",
  "id": "e8e31070-4f4b-4e4b-a8e0-40425844cb75",
  "state": "failed",
  "updated": "2018-03-01T15:23:32.497Z",
  "loggingUrl": null
}

パイプラインバージョンのコピー

指定したパイプラインバージョンとそのロギング設定をコピーします。コピーされたバージョン ready は状態にあり、後で手動でアクティブ化できます。このコマンドを使用すると、パイプラインの設定プロセスを高速化できます。

olp pipeline version copy <pipeline ID> <pipeline version ID> [command options]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

--jar <file path> ローカルファイルシステム上のパスを含む、アップロードする FAT JAR ファイル。提供されている場合、このテンプレートでパイプラインバージョンが作成されます。 JAR ファイルの内容およびビルド手順の詳細については、パイプラインサービスでのストリームアプリケーションの実行に関するチュートリアルを参照してください。
--pipeline-config <file path> 指定した出力および入力カタログを含む設定ファイル。
--with-scheduler 入力カタログの変更時にパイプラインバージョンを実行するようにスケジューラを設定します。設定されていない場合、パイプラインバージョンはアクティブ化後ただちに実行されます。このパラメータは、ストリーム環境には適用されません。 非推奨です。

パイプラインバージョンの実行モードを変更するための新しいパラメータ --schedule が olp pipeline version activate コマンドに追加されました。
--supervisor-units <size in units> スーパーバイザノードのサイズ（ 1 ～ 15 単位）。指定しない場合、値は元のパイプラインバージョンから取得されます。
--supervisor-units-profile <resource profile ID> スーパーバイザユニットに要求されたリソースプロファイルの ID 。指定しない場合、値は元のパイプラインバージョンから取得されます。現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。
--workers <number of workers> 作業者数。指定しない場合、値は元のパイプラインバージョンから取得されます。
--worker-units <size in units> ワーカーノードのサイズ (1 ～ 15 単位 ) 。指定しない場合、値は元のパイプラインバージョンから取得されます。
--worker-units-profile <resource profile ID> 作業者ユニットに要求されたリソースプロファイルの ID 。指定しない場合、値は元のパイプラインバージョンから取得されます。現在使用可能なすべてのリソースプロファイルを一覧表示するに olp pipeline profile list は、コマンドを入力します。
--credentials <path to credentials file> コマンドで使用する資格情報ファイルの名前。資格情報ファイルは、プラットフォームポータルとは別にダウンロードされます。
--profile <profile name> olpcli.ini ファイルから使用する資格情報プロファイルの名前。
--json コマンドが正常に実行された場合、パイプラインバージョンジョブを JSON 形式で表示します。
--quiet パイプラインバージョン ID を表示します。
--scope <project HRN> リクエストのスコープとして使用するプロジェクト HERE リソースネームを指定します。で指定された値 --scope は here.token.scope 、コマンドに使用された資格情報ファイルで指定された値よりも優先されます。

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

パイプラインの設定の詳細については、「パイプラインプロセスとのインターフェイス」を参照してください。

例 :

次のコマンドを使用すると、パイプラインバージョンがコピーされ、コピーされたパイプラインバージョンが新しい設定ファイルおよび Fat JAR ファイルでカスタマイズされます。

Linux

窓

olp pipeline version copy example-pipeline-id example-pipeline-version-id \
   --pipeline-config example-pipeline-configuration.conf --jar example.jar

olp pipeline version copy example-pipeline-id example-pipeline-version-id ^
   --pipeline-config example-pipeline-configuration.conf --jar example.jar

パイプラインバージョンログレベルの取得

指定したパイプラインバージョンの現在のログ設定を表示します。

olp pipeline version log level get <pipeline ID> <pipeline version ID> [command parameters]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。

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

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

ログの使用方法の詳細については、「 Logs 、 Monitoring 、 and Alerts ユーザーガイド」を参照してください。

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

例 :

Linux

窓

olp pipeline version log level get \
   f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json

olp pipeline version log level get ^
   f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json

出力 :

{"configuration": {"loggers": {
    "logger": [
        {
            "level": "info",
            "name": "com.example.someLoggingClass"
        },
        {
            "level": "info",
            "name": "com.example.examplepkg.otherClass"
        }
    ],
    "root": {"level": "error"}
}}}

パイプラインバージョンのログレベルが設定されました

指定したパイプラインバージョンの現在のログ設定を設定します。

olp pipeline version log level set <pipeline-id> <pipeline-version-id> [command parameters]

必須パラメータ :

<pipeline ID> パイプラインの ID 。
<pipeline version ID> パイプラインバージョンの ID 。
--log4j-properties <property file> ログレベルを log4j プロパティファイルの形式で設定します ( サンプルのプロパティファイルの内容については、以下を参照してください ) 。
--root <log level> ルートレベルを debug、、 info、 warnまたはの 4 つの値のいずれかに設定 errorします。ルートロガーは、コマンドラインを介して設定できます。ただし、このパラメータを使用しても、各ロガーに設定されている既存の設定は上書きされません。

警告

ログレベルを設定しています

ログレベルを設定するには、 --log4j-properties または root パラメータを使用します。

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

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

ログの使用方法の詳細については、「 Logs 、 Monitoring and Alerts ユーザーガイド」 ( ログ、監視、および警告 ) を参照してください。

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

例 :

Linux

窓

olp pipeline version log level set f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 \
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --root DEBUG --json

olp pipeline version log level set f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 ^
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --root DEBUG --json

出力 :

{
  "configuration": {
    "loggers": {
      "root": { "level": "debug" }
    }
  }
}

プロパティファイルに log4j 1.x プロパティを指定することで、ルートロガーと個別のロガーを設定できます。 rootLogger および logger プロパティのみが使用されます。

log4j プロパティファイルの例 :

# initialize root logger with level ERROR
log4j.rootLogger=ERROR
# set the log level for these components
log4j.logger.com.example.someLoggingClass=INFO
log4j.logger.com.example.examplepkg.otherClass=INFO

の詳細 log4jについては log4j 、のマニュアルを参照してください。

パイプライン バージョン

パイプラインバージョンが作成されました

必須パラメータ :

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

注

廃止されたオプションのパラメータ :

注

パイプラインバージョンがアクティブ化されました

必須パラメータ :

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

注

注

注

警告

注

--input-catalogs で pipeline-job.conf 使用しています

パイプラインバージョンのアップグレード

必須パラメータ :

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

注

パイプラインバージョンの一時停止

必須パラメータ :

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

パイプラインのバージョンが再開されます

必須パラメータ :

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

パイプラインバージョンリスト

必須パラメータ :

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

パイプラインバージョンが表示されます

必須パラメータ :

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

注

パイプラインバージョンが削除されました

必須パラメータ :

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

パイプラインバージョンがキャンセルされました

必須パラメータ :

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

パイプラインバージョン非アクティブ化

必須パラメータ :

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

パイプラインバージョンの待機中です

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

パイプラインバージョンのコピー

必須パラメータ :

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

パイプラインバージョンログレベルの取得

必須パラメータ :

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

パイプラインバージョンのログレベルが設定されました

必須パラメータ :

警告

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

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

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

パイプラインバージョン

`--input-catalogs` で `pipeline-job.conf` 使用しています

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