STARTPIPELINEEXECUTION()`¶

About StartPipelineExecution¶

Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.

Method Signature¶

METHODS /AWS1/IF_IOS~STARTPIPELINEEXECUTION
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_PIPELINENAME TYPE /AWS1/IOSRESOURCENAME OPTIONAL
    !IO_EXECENVVARIABLEOVERRIDES TYPE REF TO /AWS1/CL_IOSEXECENVVARIABLES OPTIONAL
    !IV_EXECUTIONPRIORITY TYPE /AWS1/IOSEXECUTIONPRIORITY OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOSCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosstartplinexecrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSLIMITEXCEEDEDEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspacename` `TYPE /AWS1/IOSWORKSPACENAME` `/AWS1/IOSWORKSPACENAME`¶

The name of the workspace containing the pipeline.

`iv_pipelinename` `TYPE /AWS1/IOSRESOURCENAME` `/AWS1/IOSRESOURCENAME`¶

The name of the pipeline to execute.

Optional arguments:¶

`io_execenvvariableoverrides` `TYPE REF TO /AWS1/CL_IOSEXECENVVARIABLES` `/AWS1/CL_IOSEXECENVVARIABLES`¶

Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

`iv_executionpriority` `TYPE /AWS1/IOSEXECUTIONPRIORITY` `/AWS1/IOSEXECUTIONPRIORITY`¶

Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

`iv_clienttoken` `TYPE /AWS1/IOSCLIENTTOKEN` `/AWS1/IOSCLIENTTOKEN`¶

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosstartplinexecrsp` `/AWS1/CL_IOSSTARTPLINEXECRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startpipelineexecution(
  io_execenvvariableoverrides = new /aws1/cl_iosexecenvvariables(
    it_computenodes = VALUE /aws1/cl_iosenvvariablesmap_w=>tt_computenodeenvvariablesmap(
      (
        VALUE /aws1/cl_iosenvvariablesmap_w=>ts_compnodeenvvarblsmap_maprow(
          key = |string|
          value = VALUE /aws1/cl_iosenvvariablesmap_w=>tt_environmentvariablesmap(
            (
              VALUE /aws1/cl_iosenvvariablesmap_w=>ts_envvariablesmap_maprow(
                key = |string|
                value = new /aws1/cl_iosenvvariablesmap_w( |string| )
              )
            )
          )
        )
      )
    )
    it_global = VALUE /aws1/cl_iosenvvariablesmap_w=>tt_environmentvariablesmap(
      (
        VALUE /aws1/cl_iosenvvariablesmap_w=>ts_envvariablesmap_maprow(
          key = |string|
          value = new /aws1/cl_iosenvvariablesmap_w( |string| )
        )
      )
    )
  )
  iv_clienttoken = |string|
  iv_executionpriority = 123
  iv_pipelinename = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_pipelineexecutionid( ).
ENDIF.

/AWS1/IF_IOS=>STARTPIPELINEEXECUTION()¶