STOPPIPELINEEXECUTION()`¶

About StopPipelineExecution¶

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Method Signature¶

METHODS /AWS1/IF_PIP~STOPPIPELINEEXECUTION
  IMPORTING
    !IV_PIPELINENAME TYPE /AWS1/PIPPIPELINENAME OPTIONAL
    !IV_PIPELINEEXECUTIONID TYPE /AWS1/PIPPIPELINEEXECUTIONID OPTIONAL
    !IV_ABANDON TYPE /AWS1/PIPBOOLEAN OPTIONAL
    !IV_REASON TYPE /AWS1/PIPSTOPPLINEXECREASON OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pipstopplinexecoutput
  RAISING
    /AWS1/CX_PIPCONFLICTEXCEPTION
    /AWS1/CX_PIPDUPLICATEDSTOPRE00
    /AWS1/CX_PIPPLEXNOTSTOPPABLEEX
    /AWS1/CX_PIPPIPELINENOTFOUNDEX
    /AWS1/CX_PIPVALIDATIONEX
    /AWS1/CX_PIPCLIENTEXC
    /AWS1/CX_PIPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_pipelinename` `TYPE /AWS1/PIPPIPELINENAME` `/AWS1/PIPPIPELINENAME`¶

The name of the pipeline to stop.

`iv_pipelineexecutionid` `TYPE /AWS1/PIPPIPELINEEXECUTIONID` `/AWS1/PIPPIPELINEEXECUTIONID`¶

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Optional arguments:¶

`iv_abandon` `TYPE /AWS1/PIPBOOLEAN` `/AWS1/PIPBOOLEAN`¶

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

`iv_reason` `TYPE /AWS1/PIPSTOPPLINEXECREASON` `/AWS1/PIPSTOPPLINEXECREASON`¶

Use this option to enter comments, such as the reason the pipeline was stopped.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pipstopplinexecoutput` `/AWS1/CL_PIPSTOPPLINEXECOUTPUT`¶

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->stoppipelineexecution(
  iv_abandon = ABAP_TRUE
  iv_pipelineexecutionid = |string|
  iv_pipelinename = |string|
  iv_reason = |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.

/AWS1/IF_PIP=>STOPPIPELINEEXECUTION()¶