GuidesChangelogData Inspector Library API Reference
Guides

pipeline version job

pipeline version job

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 platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the command result in JSON format.
  • --quiet Displays 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.

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

Output:

ID                                      state                                   schedule                                
12ea644c-c7a6-436e-bbc1-a895e39404cf    running                                 data-change                             
f6db24a6-1c34-447c-a21d-b36ef920c057    failed                                  none
e8e31070-4f4b-4e4b-a8e0-40425844cb75    completed                               none  

Use olp pipeline version job show <pipeline ID> <pipeline version ID> <pipeline version job ID> to display more information about a pipeline version job 

pipeline version job show

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

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 platform portal.
  • --profile <profile name> The name of the credentials profile to use from the olpcli.ini file.
  • --json Displays the content of the pipeline version job in JSON format.
  • --quiet Displays 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.

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

Output:

Details of the e8e31070-4f4b-4e4b-a8e0-40425844cb75 job:
created                                 2025-04-04T12:43:22.975075Z
updated                                 2025-04-04T12:44:32.381884Z
state                                   running
logging URL                             https://pipeline-logging-url-example.com/
pipeline UI URL                         https://pipeline-ui-url-example.com/
runtime credentials                     hrn:here:account::org:app/example-app-id
highAvailability                        false
schedule                                none
input catalogs
     ID                  HRN                                                processing type    since version    version
     catalogExample1     hrn:here:data::org:first-catalog-example-id        reprocess          -1               100
     catalogExample2     hrn:here:data::org:second-catalog-example-id       reprocess          -1               1
output catalog
     HRN            hrn:here:data::org:output-catalog-example-id
     baseVersion    2