GETREFERENCE()`¶

About GetReference¶

Downloads parts of data from a reference genome and returns the reference file in the same format that it was uploaded.

For more information, see Creating a HealthOmics reference store in the Amazon Web Services HealthOmics User Guide.

Method Signature¶

METHODS /AWS1/IF_OMX~GETREFERENCE
  IMPORTING
    !IV_ID TYPE /AWS1/OMXREFERENCEID OPTIONAL
    !IV_REFERENCESTOREID TYPE /AWS1/OMXREFERENCESTOREID OPTIONAL
    !IV_RANGE TYPE /AWS1/OMXRANGE OPTIONAL
    !IV_PARTNUMBER TYPE /AWS1/OMXINTEGER OPTIONAL
    !IV_FILE TYPE /AWS1/OMXREFERENCEFILE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxgetreferencersp
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXRANGENOTSATISFIA00
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_id` `TYPE /AWS1/OMXREFERENCEID` `/AWS1/OMXREFERENCEID`¶

The reference's ID.

`iv_referencestoreid` `TYPE /AWS1/OMXREFERENCESTOREID` `/AWS1/OMXREFERENCESTOREID`¶

The reference's store ID.

`iv_partnumber` `TYPE /AWS1/OMXINTEGER` `/AWS1/OMXINTEGER`¶

The part number to retrieve.

Optional arguments:¶

`iv_range` `TYPE /AWS1/OMXRANGE` `/AWS1/OMXRANGE`¶

The range to retrieve.

`iv_file` `TYPE /AWS1/OMXREFERENCEFILE` `/AWS1/OMXREFERENCEFILE`¶

The file to retrieve.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxgetreferencersp` `/AWS1/CL_OMXGETREFERENCERSP`¶

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->getreference(
  iv_file = |string|
  iv_id = |string|
  iv_partnumber = 123
  iv_range = |string|
  iv_referencestoreid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_referencestreamingblob = lo_result->get_payload( ).
ENDIF.

/AWS1/IF_OMX=>GETREFERENCE()¶