GETBATCH()`¶

About GetBatch¶

Retrieves details and current status for a specific run batch, including submission progress and run execution counts.

Method Signature¶

METHODS /AWS1/IF_OMX~GETBATCH
  IMPORTING
    !IV_BATCHID TYPE /AWS1/OMXBATCHID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxgetbatchresponse
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_batchid` `TYPE /AWS1/OMXBATCHID` `/AWS1/OMXBATCHID`¶

The identifier portion of the run batch ARN.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxgetbatchresponse` `/AWS1/CL_OMXGETBATCHRESPONSE`¶

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->getbatch( |string| ).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_batchid = lo_result->get_id( ).
  lv_batcharn = lo_result->get_arn( ).
  lv_batchuuid = lo_result->get_uuid( ).
  lv_batchname = lo_result->get_name( ).
  lv_batchstatus = lo_result->get_status( ).
  LOOP AT lo_result->get_tags( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_tagvalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_integer = lo_result->get_totalruns( ).
  lo_defaultrunsetting = lo_result->get_defaultrunsetting( ).
  IF lo_defaultrunsetting IS NOT INITIAL.
    lv_workflowid = lo_defaultrunsetting->get_workflowid( ).
    lv_workflowtype = lo_defaultrunsetting->get_workflowtype( ).
    lv_runrolearn = lo_defaultrunsetting->get_rolearn( ).
    lv_runname = lo_defaultrunsetting->get_name( ).
    lv_numericidinarn = lo_defaultrunsetting->get_cacheid( ).
    lv_cachebehavior = lo_defaultrunsetting->get_cachebehavior( ).
    lv_rungroupid = lo_defaultrunsetting->get_rungroupid( ).
    lv_integer = lo_defaultrunsetting->get_priority( ).
    lo_value_1 = lo_defaultrunsetting->get_parameters( ).
    IF lo_value_1 IS NOT INITIAL.
    ENDIF.
    lv_integer = lo_defaultrunsetting->get_storagecapacity( ).
    lv_runoutputuri = lo_defaultrunsetting->get_outputuri( ).
    lv_runloglevel = lo_defaultrunsetting->get_loglevel( ).
    LOOP AT lo_defaultrunsetting->get_runtags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_runretentionmode = lo_defaultrunsetting->get_retentionmode( ).
    lv_storagetype = lo_defaultrunsetting->get_storagetype( ).
    lv_workflowownerid = lo_defaultrunsetting->get_workflowownerid( ).
    lv_awsaccountid = lo_defaultrunsetting->get_outputbucketownerid( ).
    lv_workflowversionname = lo_defaultrunsetting->get_workflowversionname( ).
  ENDIF.
  lo_submissionsummary = lo_result->get_submissionsummary( ).
  IF lo_submissionsummary IS NOT INITIAL.
    lv_integer = lo_submissionsummary->get_succflstrtsubmissioncnt( ).
    lv_integer = lo_submissionsummary->get_failstartsubmissioncount( ).
    lv_integer = lo_submissionsummary->get_pendingstrtsubmissioncnt( ).
    lv_integer = lo_submissionsummary->get_succflcancsubmissioncnt( ).
    lv_integer = lo_submissionsummary->get_failcancsubmissioncount( ).
    lv_integer = lo_submissionsummary->get_succfldelsubmissioncount( ).
    lv_integer = lo_submissionsummary->get_faileddelsubmissioncount( ).
  ENDIF.
  lo_runsummary = lo_result->get_runsummary( ).
  IF lo_runsummary IS NOT INITIAL.
    lv_integer = lo_runsummary->get_pendingruncount( ).
    lv_integer = lo_runsummary->get_startingruncount( ).
    lv_integer = lo_runsummary->get_runningruncount( ).
    lv_integer = lo_runsummary->get_stoppingruncount( ).
    lv_integer = lo_runsummary->get_completedruncount( ).
    lv_integer = lo_runsummary->get_deletedruncount( ).
    lv_integer = lo_runsummary->get_failedruncount( ).
    lv_integer = lo_runsummary->get_cancelledruncount( ).
  ENDIF.
  lv_batchtimestamp = lo_result->get_creationtime( ).
  lv_batchtimestamp = lo_result->get_submittedtime( ).
  lv_batchtimestamp = lo_result->get_processedtime( ).
  lv_batchtimestamp = lo_result->get_failedtime( ).
  lv_string = lo_result->get_failurereason( ).
ENDIF.

/AWS1/IF_OMX=>GETBATCH()¶