Skip to content

/AWS1/CL_PIP=>STARTPIPELINEEXECUTION()

About StartPipelineExecution

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Method Signature

IMPORTING

Required arguments:

iv_name TYPE /AWS1/PIPPIPELINENAME /AWS1/PIPPIPELINENAME

The name of the pipeline to start.

Optional arguments:

it_variables TYPE /AWS1/CL_PIPPIPELINEVARIABLE=>TT_PIPELINEVARIABLELIST TT_PIPELINEVARIABLELIST

A list that overrides pipeline variables for a pipeline execution that's being started. Variable names must match [A-Za-z0-9@-_]+, and the values can be anything except an empty string.

iv_clientrequesttoken TYPE /AWS1/PIPCLIENTREQUESTTOKEN /AWS1/PIPCLIENTREQUESTTOKEN

The system-generated unique ID used to identify a unique execution request.

it_sourcerevisions TYPE /AWS1/CL_PIPSRCREVISIONOVERR00=>TT_SOURCEREVISIONOVERRIDELIST TT_SOURCEREVISIONOVERRIDELIST

A list that allows you to specify, or override, the source revision for a pipeline execution that's being started. A source revision is the version with all the changes to your application code, or source artifact, for the pipeline execution.

RETURNING

oo_output TYPE REF TO /aws1/cl_pipstartplinexecout /AWS1/CL_PIPSTARTPLINEXECOUT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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->/aws1/if_pip~startpipelineexecution(
  it_sourcerevisions = VALUE /aws1/cl_pipsrcrevisionoverr00=>tt_sourcerevisionoverridelist(
    (
      new /aws1/cl_pipsrcrevisionoverr00(
        iv_actionname = |string|
        iv_revisiontype = |string|
        iv_revisionvalue = |string|
      )
    )
  )
  it_variables = VALUE /aws1/cl_pippipelinevariable=>tt_pipelinevariablelist(
    (
      new /aws1/cl_pippipelinevariable(
        iv_name = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

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