/AWS1/CL_PIP=>GETPIPELINE()

About GetPipeline

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

Method Signature

IMPORTING

Required arguments:

iv_name TYPE /AWS1/PIPPIPELINENAME /AWS1/PIPPIPELINENAME

The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.

Optional arguments:

iv_version TYPE /AWS1/PIPPIPELINEVERSION /AWS1/PIPPIPELINEVERSION

The version number of the pipeline. If you do not specify a version, defaults to the current version.

RETURNING

oo_output TYPE REF TO /aws1/cl_pipgetpipelineoutput /AWS1/CL_PIPGETPIPELINEOUTPUT

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~getpipeline(
  iv_name = |string|
  iv_version = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_pipelinedeclaration = lo_result->get_pipeline( ).
  IF lo_pipelinedeclaration IS NOT INITIAL.
    lv_pipelinename = lo_pipelinedeclaration->get_name( ).
    lv_rolearn = lo_pipelinedeclaration->get_rolearn( ).
    lo_artifactstore = lo_pipelinedeclaration->get_artifactstore( ).
    IF lo_artifactstore IS NOT INITIAL.
      lv_artifactstoretype = lo_artifactstore->get_type( ).
      lv_artifactstorelocation = lo_artifactstore->get_location( ).
      lo_encryptionkey = lo_artifactstore->get_encryptionkey( ).
      IF lo_encryptionkey IS NOT INITIAL.
        lv_encryptionkeyid = lo_encryptionkey->get_id( ).
        lv_encryptionkeytype = lo_encryptionkey->get_type( ).
      ENDIF.
    ENDIF.
    LOOP AT lo_pipelinedeclaration->get_artifactstores( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_artifactstoretype = lo_value->get_type( ).
        lv_artifactstorelocation = lo_value->get_location( ).
        lo_encryptionkey = lo_value->get_encryptionkey( ).
        IF lo_encryptionkey IS NOT INITIAL.
          lv_encryptionkeyid = lo_encryptionkey->get_id( ).
          lv_encryptionkeytype = lo_encryptionkey->get_type( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    LOOP AT lo_pipelinedeclaration->get_stages( ) into lo_row_1.
      lo_row_2 = lo_row_1.
      IF lo_row_2 IS NOT INITIAL.
        lv_stagename = lo_row_2->get_name( ).
        LOOP AT lo_row_2->get_blockers( ) into lo_row_3.
          lo_row_4 = lo_row_3.
          IF lo_row_4 IS NOT INITIAL.
            lv_blockername = lo_row_4->get_name( ).
            lv_blockertype = lo_row_4->get_type( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_row_2->get_actions( ) into lo_row_5.
          lo_row_6 = lo_row_5.
          IF lo_row_6 IS NOT INITIAL.
            lv_actionname = lo_row_6->get_name( ).
            lo_actiontypeid = lo_row_6->get_actiontypeid( ).
            IF lo_actiontypeid IS NOT INITIAL.
              lv_actioncategory = lo_actiontypeid->get_category( ).
              lv_actionowner = lo_actiontypeid->get_owner( ).
              lv_actionprovider = lo_actiontypeid->get_provider( ).
              lv_version = lo_actiontypeid->get_version( ).
            ENDIF.
            lv_actionrunorder = lo_row_6->get_runorder( ).
            LOOP AT lo_row_6->get_configuration( ) into ls_row_7.
              lv_key_1 = ls_row_7-key.
              lo_value_1 = ls_row_7-value.
              IF lo_value_1 IS NOT INITIAL.
                lv_actionconfigurationvalu = lo_value_1->get_value( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_6->get_commands( ) into lo_row_8.
              lo_row_9 = lo_row_8.
              IF lo_row_9 IS NOT INITIAL.
                lv_command = lo_row_9->get_value( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_6->get_outputartifacts( ) into lo_row_10.
              lo_row_11 = lo_row_10.
              IF lo_row_11 IS NOT INITIAL.
                lv_artifactname = lo_row_11->get_name( ).
                LOOP AT lo_row_11->get_files( ) into lo_row_12.
                  lo_row_13 = lo_row_12.
                  IF lo_row_13 IS NOT INITIAL.
                    lv_filepath = lo_row_13->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_6->get_inputartifacts( ) into lo_row_14.
              lo_row_15 = lo_row_14.
              IF lo_row_15 IS NOT INITIAL.
                lv_artifactname = lo_row_15->get_name( ).
              ENDIF.
            ENDLOOP.
            LOOP AT lo_row_6->get_outputvariables( ) into lo_row_16.
              lo_row_17 = lo_row_16.
              IF lo_row_17 IS NOT INITIAL.
                lv_outputvariable = lo_row_17->get_value( ).
              ENDIF.
            ENDLOOP.
            lv_rolearn = lo_row_6->get_rolearn( ).
            lv_awsregionname = lo_row_6->get_region( ).
            lv_actionnamespace = lo_row_6->get_namespace( ).
            lv_actiontimeout = lo_row_6->get_timeoutinminutes( ).
            LOOP AT lo_row_6->get_environmentvariables( ) into lo_row_18.
              lo_row_19 = lo_row_18.
              IF lo_row_19 IS NOT INITIAL.
                lv_environmentvariablename = lo_row_19->get_name( ).
                lv_environmentvariablevalu = lo_row_19->get_value( ).
                lv_environmentvariabletype = lo_row_19->get_type( ).
              ENDIF.
            ENDLOOP.
          ENDIF.
        ENDLOOP.
        lo_failureconditions = lo_row_2->get_onfailure( ).
        IF lo_failureconditions IS NOT INITIAL.
          lv_result_1 = lo_failureconditions->get_result( ).
          lo_retryconfiguration = lo_failureconditions->get_retryconfiguration( ).
          IF lo_retryconfiguration IS NOT INITIAL.
            lv_stageretrymode = lo_retryconfiguration->get_retrymode( ).
          ENDIF.
          LOOP AT lo_failureconditions->get_conditions( ) into lo_row_20.
            lo_row_21 = lo_row_20.
            IF lo_row_21 IS NOT INITIAL.
              lv_result_1 = lo_row_21->get_result( ).
              LOOP AT lo_row_21->get_rules( ) into lo_row_22.
                lo_row_23 = lo_row_22.
                IF lo_row_23 IS NOT INITIAL.
                  lv_rulename = lo_row_23->get_name( ).
                  lo_ruletypeid = lo_row_23->get_ruletypeid( ).
                  IF lo_ruletypeid IS NOT INITIAL.
                    lv_rulecategory = lo_ruletypeid->get_category( ).
                    lv_ruleowner = lo_ruletypeid->get_owner( ).
                    lv_ruleprovider = lo_ruletypeid->get_provider( ).
                    lv_version = lo_ruletypeid->get_version( ).
                  ENDIF.
                  LOOP AT lo_row_23->get_configuration( ) into ls_row_24.
                    lv_key_2 = ls_row_24-key.
                    lo_value_2 = ls_row_24-value.
                    IF lo_value_2 IS NOT INITIAL.
                      lv_ruleconfigurationvalue = lo_value_2->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_commands( ) into lo_row_8.
                    lo_row_9 = lo_row_8.
                    IF lo_row_9 IS NOT INITIAL.
                      lv_command = lo_row_9->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_inputartifacts( ) into lo_row_14.
                    lo_row_15 = lo_row_14.
                    IF lo_row_15 IS NOT INITIAL.
                      lv_artifactname = lo_row_15->get_name( ).
                    ENDIF.
                  ENDLOOP.
                  lv_rolearn = lo_row_23->get_rolearn( ).
                  lv_awsregionname = lo_row_23->get_region( ).
                  lv_ruletimeout = lo_row_23->get_timeoutinminutes( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
        ENDIF.
        lo_successconditions = lo_row_2->get_onsuccess( ).
        IF lo_successconditions IS NOT INITIAL.
          LOOP AT lo_successconditions->get_conditions( ) into lo_row_20.
            lo_row_21 = lo_row_20.
            IF lo_row_21 IS NOT INITIAL.
              lv_result_1 = lo_row_21->get_result( ).
              LOOP AT lo_row_21->get_rules( ) into lo_row_22.
                lo_row_23 = lo_row_22.
                IF lo_row_23 IS NOT INITIAL.
                  lv_rulename = lo_row_23->get_name( ).
                  lo_ruletypeid = lo_row_23->get_ruletypeid( ).
                  IF lo_ruletypeid IS NOT INITIAL.
                    lv_rulecategory = lo_ruletypeid->get_category( ).
                    lv_ruleowner = lo_ruletypeid->get_owner( ).
                    lv_ruleprovider = lo_ruletypeid->get_provider( ).
                    lv_version = lo_ruletypeid->get_version( ).
                  ENDIF.
                  LOOP AT lo_row_23->get_configuration( ) into ls_row_24.
                    lv_key_2 = ls_row_24-key.
                    lo_value_2 = ls_row_24-value.
                    IF lo_value_2 IS NOT INITIAL.
                      lv_ruleconfigurationvalue = lo_value_2->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_commands( ) into lo_row_8.
                    lo_row_9 = lo_row_8.
                    IF lo_row_9 IS NOT INITIAL.
                      lv_command = lo_row_9->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_inputartifacts( ) into lo_row_14.
                    lo_row_15 = lo_row_14.
                    IF lo_row_15 IS NOT INITIAL.
                      lv_artifactname = lo_row_15->get_name( ).
                    ENDIF.
                  ENDLOOP.
                  lv_rolearn = lo_row_23->get_rolearn( ).
                  lv_awsregionname = lo_row_23->get_region( ).
                  lv_ruletimeout = lo_row_23->get_timeoutinminutes( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
        ENDIF.
        lo_beforeentryconditions = lo_row_2->get_beforeentry( ).
        IF lo_beforeentryconditions IS NOT INITIAL.
          LOOP AT lo_beforeentryconditions->get_conditions( ) into lo_row_20.
            lo_row_21 = lo_row_20.
            IF lo_row_21 IS NOT INITIAL.
              lv_result_1 = lo_row_21->get_result( ).
              LOOP AT lo_row_21->get_rules( ) into lo_row_22.
                lo_row_23 = lo_row_22.
                IF lo_row_23 IS NOT INITIAL.
                  lv_rulename = lo_row_23->get_name( ).
                  lo_ruletypeid = lo_row_23->get_ruletypeid( ).
                  IF lo_ruletypeid IS NOT INITIAL.
                    lv_rulecategory = lo_ruletypeid->get_category( ).
                    lv_ruleowner = lo_ruletypeid->get_owner( ).
                    lv_ruleprovider = lo_ruletypeid->get_provider( ).
                    lv_version = lo_ruletypeid->get_version( ).
                  ENDIF.
                  LOOP AT lo_row_23->get_configuration( ) into ls_row_24.
                    lv_key_2 = ls_row_24-key.
                    lo_value_2 = ls_row_24-value.
                    IF lo_value_2 IS NOT INITIAL.
                      lv_ruleconfigurationvalue = lo_value_2->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_commands( ) into lo_row_8.
                    lo_row_9 = lo_row_8.
                    IF lo_row_9 IS NOT INITIAL.
                      lv_command = lo_row_9->get_value( ).
                    ENDIF.
                  ENDLOOP.
                  LOOP AT lo_row_23->get_inputartifacts( ) into lo_row_14.
                    lo_row_15 = lo_row_14.
                    IF lo_row_15 IS NOT INITIAL.
                      lv_artifactname = lo_row_15->get_name( ).
                    ENDIF.
                  ENDLOOP.
                  lv_rolearn = lo_row_23->get_rolearn( ).
                  lv_awsregionname = lo_row_23->get_region( ).
                  lv_ruletimeout = lo_row_23->get_timeoutinminutes( ).
                ENDIF.
              ENDLOOP.
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDLOOP.
    lv_pipelineversion = lo_pipelinedeclaration->get_version( ).
    lv_executionmode = lo_pipelinedeclaration->get_executionmode( ).
    lv_pipelinetype = lo_pipelinedeclaration->get_pipelinetype( ).
    LOOP AT lo_pipelinedeclaration->get_variables( ) into lo_row_25.
      lo_row_26 = lo_row_25.
      IF lo_row_26 IS NOT INITIAL.
        lv_pipelinevariablename = lo_row_26->get_name( ).
        lv_pipelinevariablevalue = lo_row_26->get_defaultvalue( ).
        lv_pipelinevariabledescrip = lo_row_26->get_description( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_pipelinedeclaration->get_triggers( ) into lo_row_27.
      lo_row_28 = lo_row_27.
      IF lo_row_28 IS NOT INITIAL.
        lv_pipelinetriggerprovider = lo_row_28->get_providertype( ).
        lo_gitconfiguration = lo_row_28->get_gitconfiguration( ).
        IF lo_gitconfiguration IS NOT INITIAL.
          lv_actionname = lo_gitconfiguration->get_sourceactionname( ).
          LOOP AT lo_gitconfiguration->get_push( ) into lo_row_29.
            lo_row_30 = lo_row_29.
            IF lo_row_30 IS NOT INITIAL.
              lo_gittagfiltercriteria = lo_row_30->get_tags( ).
              IF lo_gittagfiltercriteria IS NOT INITIAL.
                LOOP AT lo_gittagfiltercriteria->get_includes( ) into lo_row_31.
                  lo_row_32 = lo_row_31.
                  IF lo_row_32 IS NOT INITIAL.
                    lv_gittagnamepattern = lo_row_32->get_value( ).
                  ENDIF.
                ENDLOOP.
                LOOP AT lo_gittagfiltercriteria->get_excludes( ) into lo_row_31.
                  lo_row_32 = lo_row_31.
                  IF lo_row_32 IS NOT INITIAL.
                    lv_gittagnamepattern = lo_row_32->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lo_gitbranchfiltercriteria = lo_row_30->get_branches( ).
              IF lo_gitbranchfiltercriteria IS NOT INITIAL.
                LOOP AT lo_gitbranchfiltercriteria->get_includes( ) into lo_row_33.
                  lo_row_34 = lo_row_33.
                  IF lo_row_34 IS NOT INITIAL.
                    lv_gitbranchnamepattern = lo_row_34->get_value( ).
                  ENDIF.
                ENDLOOP.
                LOOP AT lo_gitbranchfiltercriteria->get_excludes( ) into lo_row_33.
                  lo_row_34 = lo_row_33.
                  IF lo_row_34 IS NOT INITIAL.
                    lv_gitbranchnamepattern = lo_row_34->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lo_gitfilepathfiltercriter = lo_row_30->get_filepaths( ).
              IF lo_gitfilepathfiltercriter IS NOT INITIAL.
                LOOP AT lo_gitfilepathfiltercriter->get_includes( ) into lo_row_35.
                  lo_row_36 = lo_row_35.
                  IF lo_row_36 IS NOT INITIAL.
                    lv_gitfilepathpattern = lo_row_36->get_value( ).
                  ENDIF.
                ENDLOOP.
                LOOP AT lo_gitfilepathfiltercriter->get_excludes( ) into lo_row_35.
                  lo_row_36 = lo_row_35.
                  IF lo_row_36 IS NOT INITIAL.
                    lv_gitfilepathpattern = lo_row_36->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDIF.
          ENDLOOP.
          LOOP AT lo_gitconfiguration->get_pullrequest( ) into lo_row_37.
            lo_row_38 = lo_row_37.
            IF lo_row_38 IS NOT INITIAL.
              LOOP AT lo_row_38->get_events( ) into lo_row_39.
                lo_row_40 = lo_row_39.
                IF lo_row_40 IS NOT INITIAL.
                  lv_gitpullrequesteventtype = lo_row_40->get_value( ).
                ENDIF.
              ENDLOOP.
              lo_gitbranchfiltercriteria = lo_row_38->get_branches( ).
              IF lo_gitbranchfiltercriteria IS NOT INITIAL.
                LOOP AT lo_gitbranchfiltercriteria->get_includes( ) into lo_row_33.
                  lo_row_34 = lo_row_33.
                  IF lo_row_34 IS NOT INITIAL.
                    lv_gitbranchnamepattern = lo_row_34->get_value( ).
                  ENDIF.
                ENDLOOP.
                LOOP AT lo_gitbranchfiltercriteria->get_excludes( ) into lo_row_33.
                  lo_row_34 = lo_row_33.
                  IF lo_row_34 IS NOT INITIAL.
                    lv_gitbranchnamepattern = lo_row_34->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
              lo_gitfilepathfiltercriter = lo_row_38->get_filepaths( ).
              IF lo_gitfilepathfiltercriter IS NOT INITIAL.
                LOOP AT lo_gitfilepathfiltercriter->get_includes( ) into lo_row_35.
                  lo_row_36 = lo_row_35.
                  IF lo_row_36 IS NOT INITIAL.
                    lv_gitfilepathpattern = lo_row_36->get_value( ).
                  ENDIF.
                ENDLOOP.
                LOOP AT lo_gitfilepathfiltercriter->get_excludes( ) into lo_row_35.
                  lo_row_36 = lo_row_35.
                  IF lo_row_36 IS NOT INITIAL.
                    lv_gitfilepathpattern = lo_row_36->get_value( ).
                  ENDIF.
                ENDLOOP.
              ENDIF.
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lo_pipelinemetadata = lo_result->get_metadata( ).
  IF lo_pipelinemetadata IS NOT INITIAL.
    lv_pipelinearn = lo_pipelinemetadata->get_pipelinearn( ).
    lv_timestamp = lo_pipelinemetadata->get_created( ).
    lv_timestamp = lo_pipelinemetadata->get_updated( ).
    lv_timestamp = lo_pipelinemetadata->get_pollingdisabledat( ).
  ENDIF.
ENDIF.