LISTDATASETEXAMPLES()`¶

About ListDatasetExamples¶

Returns paginated examples from the dataset.

Version-pinned pagination: The server embeds the resolved version in the nextToken. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations or whether datasetVersion is passed on subsequent requests. The datasetVersion query parameter is only used for the first request (when nextToken is absent); if omitted, defaults to DRAFT.

State guard: Allowed for all statuses including DELETING.

Method Signature¶

METHODS /AWS1/IF_BDO~LISTDATASETEXAMPLES
  IMPORTING
    !IV_DATASETID TYPE /AWS1/BDODATASETID OPTIONAL
    !IV_DATASETVERSION TYPE /AWS1/BDODATASETVERSION OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/BDOINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/BDOSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdolistdsexmplsrsp
  RAISING
    /AWS1/CX_BDOACCESSDENIEDEX
    /AWS1/CX_BDOCONFLICTEXCEPTION
    /AWS1/CX_BDOINTERNALSERVEREX
    /AWS1/CX_BDORESOURCENOTFOUNDEX
    /AWS1/CX_BDOTHROTTLINGEX
    /AWS1/CX_BDOVALIDATIONEX
    /AWS1/CX_BDOCLIENTEXC
    /AWS1/CX_BDOSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_datasetid` `TYPE /AWS1/BDODATASETID` `/AWS1/BDODATASETID`¶

The unique identifier of the dataset.

Optional arguments:¶

`iv_datasetversion` `TYPE /AWS1/BDODATASETVERSION` `/AWS1/BDODATASETVERSION`¶

Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent. Only used on the first request (when nextToken is absent). For subsequent pages, the version is extracted from the nextToken and this parameter is ignored.

`iv_maxresults` `TYPE /AWS1/BDOINTEGER` `/AWS1/BDOINTEGER`¶

Maximum number of examples to return per page. Default: 1000. Min: 1, max: 1000. Response size is validated against 5 MB limit after reading. For bulk access to all examples, use the downloadUrl field from GetDataset.

`iv_nexttoken` `TYPE /AWS1/BDOSTRING` `/AWS1/BDOSTRING`¶

The token for the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_bdolistdsexmplsrsp` `/AWS1/CL_BDOLISTDSEXMPLSRSP`¶

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->listdatasetexamples(
  iv_datasetid = |string|
  iv_datasetversion = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_datasetarn = lo_result->get_datasetarn( ).
  lv_datasetid = lo_result->get_datasetid( ).
  lv_datasetversion = lo_result->get_datasetversion( ).
  LOOP AT lo_result->get_examples( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_BDO=>LISTDATASETEXAMPLES()¶