LISTJOBSBYCONSUMABLERESOURCE()`¶

About ListJobsByConsumableResource¶

Returns a list of Batch jobs that require a specific consumable resource.

Method Signature¶

METHODS /AWS1/IF_BTC~LISTJOBSBYCONSUMABLERESOURCE
  IMPORTING
    !IV_CONSUMABLERESOURCE TYPE /AWS1/BTCSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LSTJOBSBYCONSUMABLERESRCF00 OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BTCINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BTCSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_btclstjobsbyconsuma01
  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_consumableresource` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The name or ARN of the consumable resource.

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_BTCKEYVALUESPAIR=>TT_LSTJOBSBYCONSUMABLERESRCF00` `TT_LSTJOBSBYCONSUMABLERESRCF00`¶

The filters to apply to the job list query. If used, only those jobs requiring the specified consumable resource (consumableResource) and that match the value of the filters are listed. The filter names and values can be:

name: JOB_STATUS

values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED

name: JOB_NAME

The values are case-insensitive matches for the job name. If a filter value ends with an asterisk (), it matches any job name that begins with the string before the ''.

`iv_maxresults` `TYPE /AWS1/BTCINTEGER` `/AWS1/BTCINTEGER`¶

The maximum number of results returned by ListJobsByConsumableResource in paginated output. When this parameter is used, ListJobsByConsumableResource only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobsByConsumableResource request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobsByConsumableResource returns up to 100 results and a nextToken value if applicable.

`iv_nexttoken` `TYPE /AWS1/BTCSTRING` `/AWS1/BTCSTRING`¶

The nextToken value returned from a previous paginated ListJobsByConsumableResource request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_btclstjobsbyconsuma01` `/AWS1/CL_BTCLSTJOBSBYCONSUMA01`¶

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->listjobsbyconsumableresource(
  it_filters = VALUE /aws1/cl_btckeyvaluespair=>tt_lstjobsbyconsumableresrcf00(
    (
      new /aws1/cl_btckeyvaluespair(
        it_values = VALUE /aws1/cl_btcstringlist_w=>tt_stringlist(
          ( new /aws1/cl_btcstringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_consumableresource = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->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_string = lo_row_1->get_jobqueuearn( ).
      lv_string = lo_row_1->get_jobname( ).
      lv_string = lo_row_1->get_jobdefinitionarn( ).
      lv_string = lo_row_1->get_shareidentifier( ).
      lv_string = lo_row_1->get_jobstatus( ).
      lv_long = lo_row_1->get_quantity( ).
      lv_string = lo_row_1->get_statusreason( ).
      lv_long = lo_row_1->get_startedat( ).
      lv_long = lo_row_1->get_createdat( ).
      lo_consumableresourceprope = lo_row_1->get_consumableresourceprps( ).
      IF lo_consumableresourceprope IS NOT INITIAL.
        LOOP AT lo_consumableresourceprope->get_consumableresourcelist( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_consumableresource( ).
            lv_long = lo_row_3->get_quantity( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To get a list of Batch jobs by consumable resource¶