Skip to content

/AWS1/IF_IOS=>LISTDATASETDATASEGMENTS()

About ListDatasetDataSegments

Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.

Method Signature

METHODS /AWS1/IF_IOS~LISTDATASETDATASEGMENTS
  IMPORTING
    !IV_DATASETID TYPE /AWS1/IOSID OPTIONAL
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_DATASETVERSION TYPE /AWS1/IOSVERSION OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IOSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IOSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioslistdsdatasegsrsp
  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.

iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME

The name of the workspace that contains the dataset.

Optional arguments:

iv_datasetversion TYPE /AWS1/IOSVERSION /AWS1/IOSVERSION

The version of the dataset to list data segments for.

iv_maxresults TYPE /AWS1/IOSMAXRESULTS /AWS1/IOSMAXRESULTS

The maximum number of results to return for each paginated request. Default: 50.

iv_nexttoken TYPE /AWS1/IOSNEXTTOKEN /AWS1/IOSNEXTTOKEN

The token to be used for the next set of paginated results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioslistdsdatasegsrsp /AWS1/CL_IOSLISTDSDATASEGSRSP

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->listdatasetdatasegments(
  iv_datasetid = |string|
  iv_datasetversion = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_workspacename = |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_datasegments( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_id = lo_row_1->get_sourcedatasetid( ).
      lv_timeseriesid = lo_row_1->get_timeseriesid( ).
      lo_timeinnanos = lo_row_1->get_starttimestamp( ).
      IF lo_timeinnanos IS NOT INITIAL.
        lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
        lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
      ENDIF.
      lo_timeinnanos = lo_row_1->get_endtimestamp( ).
      IF lo_timeinnanos IS NOT INITIAL.
        lv_timeinseconds = lo_timeinnanos->get_timeinseconds( ).
        lv_offsetinnanos = lo_timeinnanos->get_offsetinnanos( ).
      ENDIF.
      lv_propertyalias = lo_row_1->get_alias( ).
      lv_propertydatatype = lo_row_1->get_datatype( ).
      lo_datasegmentenrichment = lo_row_1->get_enrichment( ).
      IF lo_datasegmentenrichment IS NOT INITIAL.
        lv_enrichmentstatus = lo_datasegmentenrichment->get_status( ).
        lv_timestamp = lo_datasegmentenrichment->get_lastenrichedat( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.