/AWS1/IF_IOS=>DESCRIBEDATASET()

About DescribeDataset

Retrieves information about a dataset.

Method Signature

METHODS /AWS1/IF_IOS~DESCRIBEDATASET
  IMPORTING
    !IV_DATASETID TYPE /AWS1/IOSID OPTIONAL
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_DATASETVERSION TYPE /AWS1/IOSVERSION OPTIONAL
  PREFERRED PARAMETER iv_datasetid
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosdescrdatasetrsp
  RAISING
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_datasetid TYPE /AWS1/IOSID /AWS1/IOSID

The ID of the dataset.

Optional arguments:

iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME

The name of the workspace that contains the dataset.

iv_datasetversion TYPE /AWS1/IOSVERSION /AWS1/IOSVERSION

The version of the dataset.

RETURNING

oo_output TYPE REF TO /aws1/cl_iosdescrdatasetrsp /AWS1/CL_IOSDESCRDATASETRSP

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->describedataset(
  iv_datasetid = |string|
  iv_datasetversion = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_datasetid( ).
  lv_arn = lo_result->get_datasetarn( ).
  lv_restrictedname = lo_result->get_datasetname( ).
  lv_description = lo_result->get_datasetdescription( ).
  lv_datasettypeenum = lo_result->get_datasettype( ).
  lo_datasetconfig = lo_result->get_datasetconfig( ).
  IF lo_datasetconfig IS NOT INITIAL.
    lo_sessionconfig = lo_datasetconfig->get_session( ).
    IF lo_sessionconfig IS NOT INITIAL.
      lo_timeinnanos = lo_sessionconfig->get_sessionstarttimestamp( ).
      IF lo_timeinnanos IS NOT INITIAL.
        lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
        lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
      ENDIF.
      lo_timeinnanos = lo_sessionconfig->get_sessionendtimestamp( ).
      IF lo_timeinnanos IS NOT INITIAL.
        lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
        lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
      ENDIF.
    ENDIF.
  ENDIF.
  lv_workspacename = lo_result->get_workspacename( ).
  LOOP AT lo_result->get_metadata( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_metadatavalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_datasetsource = lo_result->get_datasetsource( ).
  IF lo_datasetsource IS NOT INITIAL.
    lv_datasetsourcetype = lo_datasetsource->get_sourcetype( ).
    lv_datasetsourceformat = lo_datasetsource->get_sourceformat( ).
    lo_sourcedetail = lo_datasetsource->get_sourcedetail( ).
    IF lo_sourcedetail IS NOT INITIAL.
      lo_kendrasourcedetail = lo_sourcedetail->get_kendra( ).
      IF lo_kendrasourcedetail IS NOT INITIAL.
        lv_arn = lo_kendrasourcedetail->get_knowledgebasearn( ).
        lv_arn = lo_kendrasourcedetail->get_rolearn( ).
      ENDIF.
    ENDIF.
  ENDIF.
  lo_datasetstatus = lo_result->get_datasetstatus( ).
  IF lo_datasetstatus IS NOT INITIAL.
    lv_datasetstate = lo_datasetstatus->get_state( ).
    lo_errordetails = lo_datasetstatus->get_error( ).
    IF lo_errordetails IS NOT INITIAL.
      lv_errorcode = lo_errordetails->get_code( ).
      lv_errormessage = lo_errordetails->get_message( ).
      LOOP AT lo_errordetails->get_details( ) into lo_row_1.
        lo_row_2 = lo_row_1.
        IF lo_row_2 IS NOT INITIAL.
          lv_detailederrorcode = lo_row_2->get_code( ).
          lv_detailederrormessage = lo_row_2->get_message( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDIF.
  lv_timestamp = lo_result->get_datasetcreationdate( ).
  lv_timestamp = lo_result->get_datasetlastupdatedate( ).
  lv_version = lo_result->get_datasetversion( ).
  lo_datasetenrichment = lo_result->get_enrichmentstatus( ).
  IF lo_datasetenrichment IS NOT INITIAL.
    lo_datasetenrichmententry = lo_datasetenrichment->get_video( ).
    IF lo_datasetenrichmententry IS NOT INITIAL.
      lv_datasetenrichmentstatus = lo_datasetenrichmententry->get_status( ).
      lv_timestamp = lo_datasetenrichmententry->get_lastenrichedat( ).
    ENDIF.
  ENDIF.
ENDIF.