GETLOADERJOBSTATUS()`¶

About GetLoaderJobStatus¶

Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per job.

See Neptune Loader Get-Status API for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetLoaderJobStatus IAM action in that cluster..

Method Signature¶

METHODS /AWS1/IF_NED~GETLOADERJOBSTATUS
  IMPORTING
    !IV_LOADID TYPE /AWS1/NEDSTRING OPTIONAL
    !IV_DETAILS TYPE /AWS1/NEDBOOLEAN OPTIONAL
    !IV_ERRORS TYPE /AWS1/NEDBOOLEAN OPTIONAL
    !IV_PAGE TYPE /AWS1/NEDPOSITIVEINTEGER OPTIONAL
    !IV_ERRORSPERPAGE TYPE /AWS1/NEDPOSITIVEINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_nedgetloaderjobstat01
  RAISING
    /AWS1/CX_NEDBADREQUESTEX
    /AWS1/CX_NEDBULKLOADIDNOTFNDEX
    /AWS1/CX_NEDCLIENTTIMEOUTEX
    /AWS1/CX_NEDCNSTRNTVIOLATIONEX
    /AWS1/CX_NEDILLEGALARGUMENTEX
    /AWS1/CX_NEDINTERNALFAILUREEX
    /AWS1/CX_NEDINVALIDARGUMENTEX
    /AWS1/CX_NEDINVALIDPARAMETEREX
    /AWS1/CX_NEDLOADURLACCDENIEDEX
    /AWS1/CX_NEDMISSINGPARAMETEREX
    /AWS1/CX_NEDPRECONDSFAILEDEX
    /AWS1/CX_NEDTOOMANYREQUESTSEX
    /AWS1/CX_NEDUNSUPPORTEDOPEX
    /AWS1/CX_NEDCLIENTEXC
    /AWS1/CX_NEDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_loadid` `TYPE /AWS1/NEDSTRING` `/AWS1/NEDSTRING`¶

The load ID of the load job to get the status of.

Optional arguments:¶

`iv_details` `TYPE /AWS1/NEDBOOLEAN` `/AWS1/NEDBOOLEAN`¶

Flag indicating whether or not to include details beyond the overall status (TRUE or FALSE; the default is FALSE).

`iv_errors` `TYPE /AWS1/NEDBOOLEAN` `/AWS1/NEDBOOLEAN`¶

Flag indicating whether or not to include a list of errors encountered (TRUE or FALSE; the default is FALSE).

The list of errors is paged. The page and errorsPerPage parameters allow you to page through all the errors.

`iv_page` `TYPE /AWS1/NEDPOSITIVEINTEGER` `/AWS1/NEDPOSITIVEINTEGER`¶

The error page number (a positive integer; the default is 1). Only valid when the errors parameter is set to TRUE.

`iv_errorsperpage` `TYPE /AWS1/NEDPOSITIVEINTEGER` `/AWS1/NEDPOSITIVEINTEGER`¶

The number of errors returned in each page (a positive integer; the default is 10). Only valid when the errors parameter set to TRUE.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_nedgetloaderjobstat01` `/AWS1/CL_NEDGETLOADERJOBSTAT01`¶

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->getloaderjobstatus(
  iv_details = ABAP_TRUE
  iv_errors = ABAP_TRUE
  iv_errorsperpage = 123
  iv_loadid = |string|
  iv_page = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_status( ).
  lo_value = lo_result->get_payload( ).
  IF lo_value IS NOT INITIAL.
  ENDIF.
ENDIF.

/AWS1/IF_NED=>GETLOADERJOBSTATUS()¶