pipeline snapshot

The OLP CLI supports the following:

• list all pipeline snapshots
• show a specific pipeline snapshot

Stream pipelines using runtime environment stream-5.0 and newer can restore application state from a snapshot. As stream pipelines use Apache Flink for runtime, the snapshots are essentially savepoints in Flink. To activate a pipeline using a snapshot, use the olp pipeline version activate --snapshot-id <snapshot-id> command.

pipeline snapshot list

Lists all the snapshots belonging to the specified pipeline.

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

Required parameters:

• <pipeline ID> The ID of the pipeline.

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 list of pipeline snapshots in JSON format.
• --quiet Displays snapshot 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 snapshots for the specified pipeline.

olp pipeline snapshot list \
   4a7ccbb2-166c-41ca-9101-80e09e3fec8f --json

olp pipeline snapshot list ^
   4a7ccbb2-166c-41ca-9101-80e09e3fec8f --json

Output:

{
    "snapshots": [
        {
            "jobId": "0acf30d8-b4c7-4ccd-ac16-f4174a914271",
            "created": "2022-03-08T04:30:19.775996Z",
            "pipelineVersionId": "575e2b60-e269-42a6-a5f5-7497bd6a41d0",
            "id": "280451c4-917c-4546-b2b7-9e3aed5216ad",
            "region": "us-oregon",
            "templateId": "7ab42b80-05fd-48e5-b42f-574ab8a10f3d",
            "pipelineId": "4a7ccbb2-166c-41ca-9101-80e09e3fec8f"
        },
        {
            "jobId": "0acf30d8-b4c7-4ccd-ac16-f4174a914271",
            "created": "2022-03-08T04:00:16.400657Z",
            "pipelineVersionId": "575e2b60-e269-42a6-a5f5-7497bd6a41d0",
            "id": "6f690ad3-901f-4093-97da-85200d581d82",
            "region": "us-oregon",
            "templateId": "7ab42b80-05fd-48e5-b42f-574ab8a10f3d",
            "pipelineId": "4a7ccbb2-166c-41ca-9101-80e09e3fec8f"
        }
    ]
}

pipeline snapshot show

Shows all the information about a specific snapshot of a specified pipeline.

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

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

Required parameters:

• <pipeline ID> The pipeline ID.
• <snapshot ID> The snapshot ID.

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 snapshot in JSON format.
• --quiet Displays the state of the pipeline snapshot.
• --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 of the specified snapshot.

olp pipeline snapshot show 4a7ccbb2-166c-41ca-9101-80e09e3fec8f \
   280451c4-917c-4546-b2b7-9e3aed5216ad --json

olp pipeline snapshot show 4a7ccbb2-166c-41ca-9101-80e09e3fec8f ^
   280451c4-917c-4546-b2b7-9e3aed5216ad --json

Output:

{
    "jobId": "0acf30d8-b4c7-4ccd-ac16-f4174a914271",
    "created": "2022-03-08T04:30:19.775996Z",
    "pipelineVersionId": "575e2b60-e269-42a6-a5f5-7497bd6a41d0",
    "id": "280451c4-917c-4546-b2b7-9e3aed5216ad",
    "region": "us-oregon",
    "templateId": "7ab42b80-05fd-48e5-b42f-574ab8a10f3d",
    "pipelineId": "4a7ccbb2-166c-41ca-9101-80e09e3fec8f"
}