Jobs

The OLP CLI supports the following:

  • list all pipeline version jobs
  • show all pipeline version jobs

pipeline version job list

Lists all the jobs belonging to the specified pipeline version.

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

Required parameters:

  • <pipeline ID> The ID of the pipeline.
  • <pipeline version ID> The ID of the pipeline version.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the OLP Portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Display the list of pipeline version jobs in JSON format.
  • --quiet Display job IDs, each on a new line.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials Setup.

Example:

The command below lists all the jobs for the specified pipeline version.

Linux
Windows
olp pipeline version job list \
   f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json
olp pipeline version job list ^
   f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 d77f288e-2c89-4c94-b4ba-79fbd1e26e79 --json

Output:

{"pipelineVersionJobs": [
    {
        "catalogVersions": null,
        "created": "2018-03-01T15:25:21.789Z",
        "id": "f6db24a6-1c34-447c-a21d-b36ef920c057",
        "state": "failed",
        "updated": "2018-03-01T15:25:34.591Z",
        "loggingUrl": null,
        "highAvailability": false
    },
    {
        "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,
        "highAvailability": false
    }
]}

pipeline version job show

Shows all the information about a processing job for the specified pipeline version.

Linux
Windows
olp pipeline version job show <pipeline ID> <pipeline version ID> \
   <pipeline version job ID> [command option]
olp pipeline version job show <pipeline ID> <pipeline version ID> ^
   <pipeline version job ID> [command option]

Required parameters:

  • <pipeline ID> The ID of the pipeline.
  • <pipeline version ID> The ID of the pipeline version.
  • <pipeline version job ID> The job ID for the specified pipeline and pipeline version.

Optional parameters:

  • --credentials <path to credentials file> The name of a credentials file to use with the command. Credentials files are downloaded separately from the OLP Portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Display the content of the pipeline version job in JSON format.
  • --quiet Display the state of the pipeline version job.
  • --scope <project HRN> Specifies the project HRN to use as the scope in the request. The value specified with --scope overrides any value for here.token.scope provided in the credentials file used for the command.

For more information on using credentials and profiles, see Credentials Setup.

Example:

The command below displays the information for the specified job.

Linux
Windows
olp pipeline version job show f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 \
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 e8e31070-4f4b-4e4b-a8e0-40425844cb75 --json
olp pipeline version job show f2fc50c4-a0ac-4c8a-9637-0d9b3a0d4a96 ^
   d77f288e-2c89-4c94-b4ba-79fbd1e26e79 e8e31070-4f4b-4e4b-a8e0-40425844cb75 --json

Output:

{
    "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,
    "pipelineUIUrl": "https://pipelines-ui-proxy.platform.here.com/sparkui/olp-here/e8e31070-4f4b-4e4b-a8e0-40425844cb75",
    "highAvailability": false
}

results matching ""

    No results matching ""