LISTSEARCHJOBS()`¶

About ListSearchJobs¶

This operation returns a list of search jobs belonging to an account.

Method Signature¶

METHODS /AWS1/IF_BUR~LISTSEARCHJOBS
  IMPORTING
    !IV_BYSTATUS TYPE /AWS1/BURSEARCHJOBSTATE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BURSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BURINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_burlistsrchjobsoutput
  RAISING
    /AWS1/CX_BURACCESSDENIEDEX
    /AWS1/CX_BURINTERNALSERVEREX
    /AWS1/CX_BURTHROTTLINGEX
    /AWS1/CX_BURVALIDATIONEX
    /AWS1/CX_BURCLIENTEXC
    /AWS1/CX_BURSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_bystatus` `TYPE /AWS1/BURSEARCHJOBSTATE` `/AWS1/BURSEARCHJOBSTATE`¶

Include this parameter to filter list by search job status.

`iv_nexttoken` `TYPE /AWS1/BURSTRING` `/AWS1/BURSTRING`¶

The next item following a partial list of returned search jobs.

For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

`iv_maxresults` `TYPE /AWS1/BURINTEGER` `/AWS1/BURINTEGER`¶

The maximum number of resource list items to be returned.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_burlistsrchjobsoutput` `/AWS1/CL_BURLISTSRCHJOBSOUTPUT`¶

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->listsearchjobs(
  iv_bystatus = |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_searchjobs( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_genericid = lo_row_1->get_searchjobidentifier( ).
      lv_searchjobarn = lo_row_1->get_searchjobarn( ).
      lv_string = lo_row_1->get_name( ).
      lv_searchjobstate = lo_row_1->get_status( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_completiontime( ).
      lo_searchscopesummary = lo_row_1->get_searchscopesummary( ).
      IF lo_searchscopesummary IS NOT INITIAL.
        lv_integer = lo_searchscopesummary->get_totalrecpointstoscancnt( ).
        lv_long = lo_searchscopesummary->get_totalitemstoscancount( ).
      ENDIF.
      lv_string = lo_row_1->get_statusmessage( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BUR=>LISTSEARCHJOBS()¶