GETJOBQUEUESNAPSHOT()`¶

About GetJobQueueSnapshot¶

Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.

Method Signature¶

METHODS /AWS1/IF_BTC~GETJOBQUEUESNAPSHOT
  IMPORTING
    !IV_JOBQUEUE TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btcgetjobqueuesnaprsp
  RAISING
    /AWS1/CX_BTCCLIENTEXCEPTION
    /AWS1/CX_BTCSERVEREXCEPTION
    /AWS1/CX_BTCCLIENTEXC
    /AWS1/CX_BTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_jobqueue` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The job queue’s name or full queue Amazon Resource Name (ARN).

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_btcgetjobqueuesnaprsp` `/AWS1/CL_BTCGETJOBQUEUESNAPRSP`¶

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

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_frontofqueuedetail = lo_result->get_frontofqueue( ).
  IF lo_frontofqueuedetail IS NOT INITIAL.
    LOOP AT lo_frontofqueuedetail->get_jobs( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_jobarn( ).
        lv_long = lo_row_1->get_earliesttimeatposition( ).
      ENDIF.
    ENDLOOP.
    lv_long = lo_frontofqueuedetail->get_lastupdatedat( ).
  ENDIF.
  lo_frontofquotasharesdetai = lo_result->get_frontofquotashares( ).
  IF lo_frontofquotasharesdetai IS NOT INITIAL.
    LOOP AT lo_frontofquotasharesdetai->get_quotashares( ) into ls_row_2.
      lv_key = ls_row_2-key.
      LOOP AT ls_row_2-value into lo_row_3.
        lo_row_4 = lo_row_3.
        IF lo_row_4 IS NOT INITIAL.
          lv_string = lo_row_4->get_jobarn( ).
          lv_long = lo_row_4->get_earliesttimeatposition( ).
        ENDIF.
      ENDLOOP.
    ENDLOOP.
    lv_long = lo_frontofquotasharesdetai->get_lastupdatedat( ).
  ENDIF.
  lo_queuesnapshotutilizatio = lo_result->get_queueutilization( ).
  IF lo_queuesnapshotutilizatio IS NOT INITIAL.
    LOOP AT lo_queuesnapshotutilizatio->get_totalcapacityusage( ) into lo_row_5.
      lo_row_6 = lo_row_5.
      IF lo_row_6 IS NOT INITIAL.
        lv_string = lo_row_6->get_capacityunit( ).
        lv_double = lo_row_6->get_quantity( ).
      ENDIF.
    ENDLOOP.
    lo_fairshareutilizationdet = lo_queuesnapshotutilizatio->get_fairshareutilization( ).
    IF lo_fairshareutilizationdet IS NOT INITIAL.
      lv_long = lo_fairshareutilizationdet->get_activesharecount( ).
      LOOP AT lo_fairshareutilizationdet->get_topcapacityutilization( ) into lo_row_7.
        lo_row_8 = lo_row_7.
        IF lo_row_8 IS NOT INITIAL.
          lv_string = lo_row_8->get_shareidentifier( ).
          LOOP AT lo_row_8->get_capacityusage( ) into lo_row_9.
            lo_row_10 = lo_row_9.
            IF lo_row_10 IS NOT INITIAL.
              lv_string = lo_row_10->get_capacityunit( ).
              lv_double = lo_row_10->get_quantity( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_quotashareutilizationde = lo_queuesnapshotutilizatio->get_quotashareutilization( ).
    IF lo_quotashareutilizationde IS NOT INITIAL.
      LOOP AT lo_quotashareutilizationde->get_topcapacityutilization( ) into lo_row_11.
        lo_row_12 = lo_row_11.
        IF lo_row_12 IS NOT INITIAL.
          lv_string = lo_row_12->get_quotasharename( ).
          LOOP AT lo_row_12->get_capacityusage( ) into lo_row_13.
            lo_row_14 = lo_row_13.
            IF lo_row_14 IS NOT INITIAL.
              lv_string = lo_row_14->get_capacityunit( ).
              lv_double = lo_row_14->get_quantity( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
    lv_long = lo_queuesnapshotutilizatio->get_lastupdatedat( ).
  ENDIF.
ENDIF.

/AWS1/IF_BTC=>GETJOBQUEUESNAPSHOT()¶