/AWS1/IF_OSI=>GETPIPELINEBLUEPRINT()

About GetPipelineBlueprint

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.

Method Signature

METHODS /AWS1/IF_OSI~GETPIPELINEBLUEPRINT
  IMPORTING
    !IV_BLUEPRINTNAME TYPE /AWS1/OSISTRING OPTIONAL
    !IV_FORMAT TYPE /AWS1/OSIBLUEPRINTFORMAT OPTIONAL
  PREFERRED PARAMETER iv_blueprintname
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osigetplblueprintrsp
  RAISING
    /AWS1/CX_OSIACCESSDENIEDEX
    /AWS1/CX_OSIDISABLEDOPEX
    /AWS1/CX_OSIINTERNALEXCEPTION
    /AWS1/CX_OSIRESOURCENOTFOUNDEX
    /AWS1/CX_OSIVALIDATIONEX
    /AWS1/CX_OSICLIENTEXC
    /AWS1/CX_OSISERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_blueprintname TYPE /AWS1/OSISTRING /AWS1/OSISTRING

The name of the blueprint to retrieve.

Optional arguments:

iv_format TYPE /AWS1/OSIBLUEPRINTFORMAT /AWS1/OSIBLUEPRINTFORMAT

The format format of the blueprint to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_osigetplblueprintrsp /AWS1/CL_OSIGETPLBLUEPRINTRSP

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->getpipelineblueprint(
  iv_blueprintname = |string|
  iv_format = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_pipelineblueprint = lo_result->get_blueprint( ).
  IF lo_pipelineblueprint IS NOT INITIAL.
    lv_string = lo_pipelineblueprint->get_blueprintname( ).
    lv_string = lo_pipelineblueprint->get_pipelineconfbody( ).
    lv_string = lo_pipelineblueprint->get_displayname( ).
    lv_string = lo_pipelineblueprint->get_displaydescription( ).
    lv_string = lo_pipelineblueprint->get_service( ).
    lv_string = lo_pipelineblueprint->get_usecase( ).
  ENDIF.
  lv_string = lo_result->get_format( ).
ENDIF.