GETREADSETMETADATA()`¶

About GetReadSetMetadata¶

Retrieves the metadata for a read set from a sequence store in JSON format. This operation does not return tags. To retrieve the list of tags for a read set, use the ListTagsForResource API operation.

Method Signature¶

METHODS /AWS1/IF_OMX~GETREADSETMETADATA
  IMPORTING
    !IV_ID TYPE /AWS1/OMXREADSETID OPTIONAL
    !IV_SEQUENCESTOREID TYPE /AWS1/OMXSEQUENCESTOREID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxgetreadsetmetrsp
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /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/OMXREADSETID` `/AWS1/OMXREADSETID`¶

The read set's ID.

`iv_sequencestoreid` `TYPE /AWS1/OMXSEQUENCESTOREID` `/AWS1/OMXSEQUENCESTOREID`¶

The read set's sequence store ID.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxgetreadsetmetrsp` `/AWS1/CL_OMXGETREADSETMETRSP`¶

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->getreadsetmetadata(
  iv_id = |string|
  iv_sequencestoreid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_readsetid = lo_result->get_id( ).
  lv_readsetarn = lo_result->get_arn( ).
  lv_sequencestoreid = lo_result->get_sequencestoreid( ).
  lv_subjectid = lo_result->get_subjectid( ).
  lv_sampleid = lo_result->get_sampleid( ).
  lv_readsetstatus = lo_result->get_status( ).
  lv_readsetname = lo_result->get_name( ).
  lv_readsetdescription = lo_result->get_description( ).
  lv_filetype = lo_result->get_filetype( ).
  lv_timestamp = lo_result->get_creationtime( ).
  lo_sequenceinformation = lo_result->get_sequenceinformation( ).
  IF lo_sequenceinformation IS NOT INITIAL.
    lv_long = lo_sequenceinformation->get_totalreadcount( ).
    lv_long = lo_sequenceinformation->get_totalbasecount( ).
    lv_generatedfrom = lo_sequenceinformation->get_generatedfrom( ).
    lv_string = lo_sequenceinformation->get_alignment( ).
  ENDIF.
  lv_referencearn = lo_result->get_referencearn( ).
  lo_readsetfiles = lo_result->get_files( ).
  IF lo_readsetfiles IS NOT INITIAL.
    lo_fileinformation = lo_readsetfiles->get_source1( ).
    IF lo_fileinformation IS NOT INITIAL.
      lv_integer = lo_fileinformation->get_totalparts( ).
      lv_long = lo_fileinformation->get_partsize( ).
      lv_long = lo_fileinformation->get_contentlength( ).
      lo_readsets3access = lo_fileinformation->get_s3access( ).
      IF lo_readsets3access IS NOT INITIAL.
        lv_s3uri = lo_readsets3access->get_s3uri( ).
      ENDIF.
    ENDIF.
    lo_fileinformation = lo_readsetfiles->get_source2( ).
    IF lo_fileinformation IS NOT INITIAL.
      lv_integer = lo_fileinformation->get_totalparts( ).
      lv_long = lo_fileinformation->get_partsize( ).
      lv_long = lo_fileinformation->get_contentlength( ).
      lo_readsets3access = lo_fileinformation->get_s3access( ).
      IF lo_readsets3access IS NOT INITIAL.
        lv_s3uri = lo_readsets3access->get_s3uri( ).
      ENDIF.
    ENDIF.
    lo_fileinformation = lo_readsetfiles->get_index( ).
    IF lo_fileinformation IS NOT INITIAL.
      lv_integer = lo_fileinformation->get_totalparts( ).
      lv_long = lo_fileinformation->get_partsize( ).
      lv_long = lo_fileinformation->get_contentlength( ).
      lo_readsets3access = lo_fileinformation->get_s3access( ).
      IF lo_readsets3access IS NOT INITIAL.
        lv_s3uri = lo_readsets3access->get_s3uri( ).
      ENDIF.
    ENDIF.
  ENDIF.
  lv_readsetstatusmessage = lo_result->get_statusmessage( ).
  lv_creationtype = lo_result->get_creationtype( ).
  lo_etag = lo_result->get_etag( ).
  IF lo_etag IS NOT INITIAL.
    lv_etagalgorithm = lo_etag->get_algorithm( ).
    lv_string = lo_etag->get_source1( ).
    lv_string = lo_etag->get_source2( ).
  ENDIF.
  lv_creationjobid = lo_result->get_creationjobid( ).
ENDIF.

/AWS1/IF_OMX=>GETREADSETMETADATA()¶