LISTSEARCHJOBBACKUPS()`¶

About ListSearchJobBackups¶

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

Method Signature¶

METHODS /AWS1/IF_BUR~LISTSEARCHJOBBACKUPS
  IMPORTING
    !IV_SEARCHJOBIDENTIFIER TYPE /AWS1/BURGENERICID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BURSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BURINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_burlstsrchjobbackup01
  RAISING
    /AWS1/CX_BURACCESSDENIEDEX
    /AWS1/CX_BURINTERNALSERVEREX
    /AWS1/CX_BURTHROTTLINGEX
    /AWS1/CX_BURVALIDATIONEX
    /AWS1/CX_BURRESOURCENOTFOUNDEX
    /AWS1/CX_BURCLIENTEXC
    /AWS1/CX_BURSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_searchjobidentifier` `TYPE /AWS1/BURGENERICID` `/AWS1/BURGENERICID`¶

The unique string that specifies the search job.

Optional arguments:¶

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

The next item following a partial list of returned backups included in a search job.

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_burlstsrchjobbackup01` `/AWS1/CL_BURLSTSRCHJOBBACKUP01`¶

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->listsearchjobbackups(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_searchjobidentifier = |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_results( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_searchjobstate = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_statusmessage( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_string = lo_row_1->get_backupresourcearn( ).
      lv_string = lo_row_1->get_sourceresourcearn( ).
      lv_timestamp = lo_row_1->get_indexcreationtime( ).
      lv_timestamp = lo_row_1->get_backupcreationtime( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BUR=>LISTSEARCHJOBBACKUPS()¶