DESCRIBEPIPELINE()`¶

About DescribePipeline¶

Retrieves detailed information about a specific pipeline in a workspace.

Method Signature¶

METHODS /AWS1/IF_IOS~DESCRIBEPIPELINE
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_PIPELINENAME TYPE /AWS1/IOSRESOURCENAME OPTIONAL
    !IV_PIPELINEVERSION TYPE /AWS1/IOSVERSION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosdescrplinresponse
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /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.

Optional arguments:¶

`iv_pipelineversion` `TYPE /AWS1/IOSVERSION` `/AWS1/IOSVERSION`¶

The version number of the pipeline to retrieve. If not specified, returns the latest version.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iosdescrplinresponse` `/AWS1/CL_IOSDESCRPLINRESPONSE`¶

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->describepipeline(
  iv_pipelinename = |string|
  iv_pipelineversion = |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_resourcename = lo_result->get_pipelinename( ).
  lv_workspacename = lo_result->get_workspacename( ).
  lv_description = lo_result->get_description( ).
  lv_arn = lo_result->get_pipelinearn( ).
  lv_version = lo_result->get_version( ).
  LOOP AT lo_result->get_environmentvariables( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_environmentvariablevalu = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_computations( ) into lo_row_1.
    lo_row_2 = lo_row_1.
    IF lo_row_2 IS NOT INITIAL.
      lv_resourcename = lo_row_2->get_computenodename( ).
      lv_resourcename = lo_row_2->get_taskname( ).
      LOOP AT lo_row_2->get_environmentvariables( ) into ls_row.
        lv_key = ls_row-key.
        lo_value = ls_row-value.
        IF lo_value IS NOT INITIAL.
          lv_environmentvariablevalu = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_2->get_dependson( ) into lo_row_3.
        lo_row_4 = lo_row_3.
        IF lo_row_4 IS NOT INITIAL.
          lv_resourcename = lo_row_4->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lo_resourcestatus = lo_result->get_status( ).
  IF lo_resourcestatus IS NOT INITIAL.
    lo_resourceerror = lo_resourcestatus->get_error( ).
    IF lo_resourceerror IS NOT INITIAL.
      lv_resourceerrorcode = lo_resourceerror->get_code( ).
      lv_string = lo_resourceerror->get_message( ).
    ENDIF.
    lv_resourcestate = lo_resourcestatus->get_state( ).
  ENDIF.
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_updatedat( ).
ENDIF.

/AWS1/IF_IOS=>DESCRIBEPIPELINE()¶