CANCELPIPELINEEXECUTION()`¶

About CancelPipelineExecution¶

Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.

Method Signature¶

METHODS /AWS1/IF_IOS~CANCELPIPELINEEXECUTION
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_PIPELINENAME TYPE /AWS1/IOSRESOURCENAME OPTIONAL
    !IV_PIPELINEEXECUTIONID TYPE /AWS1/IOSID OPTIONAL
    !IV_REASON TYPE /AWS1/IOSCANCPLINEXECREQRSNSTR OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioscancelplinexecrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /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.

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

The name of the pipeline.

`iv_pipelineexecutionid` `TYPE /AWS1/IOSID` `/AWS1/IOSID`¶

The unique identifier of the pipeline execution.

Optional arguments:¶

`iv_reason` `TYPE /AWS1/IOSCANCPLINEXECREQRSNSTR` `/AWS1/IOSCANCPLINEXECREQRSNSTR`¶

A message describing why the pipeline execution is being cancelled.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioscancelplinexecrsp` `/AWS1/CL_IOSCANCELPLINEXECRSP`¶

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->cancelpipelineexecution(
  iv_pipelineexecutionid = |string|
  iv_pipelinename = |string|
  iv_reason = |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_pipelineexecutionstate = lo_result->get_state( ).
ENDIF.

/AWS1/IF_IOS=>CANCELPIPELINEEXECUTION()¶