STRTDATAQUALITYRLSETEVALRUN()`¶

About StartDataQualityRulesetEvaluationRun¶

Once you have a ruleset definition (either recommended or your own), you call this operation to evaluate the ruleset against a data source (Glue table). The evaluation computes results which you can retrieve with the GetDataQualityResult API.

Method Signature¶

METHODS /AWS1/IF_GLU~STRTDATAQUALITYRLSETEVALRUN
  IMPORTING
    !IO_DATASOURCE TYPE REF TO /AWS1/CL_GLUDATASOURCE OPTIONAL
    !IV_ROLE TYPE /AWS1/GLUROLESTRING OPTIONAL
    !IV_NUMBEROFWORKERS TYPE /AWS1/GLUNULLABLEINTEGER OPTIONAL
    !IV_TIMEOUT TYPE /AWS1/GLUTIMEOUT OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/GLUHASHSTRING OPTIONAL
    !IO_ADDITIONALRUNOPTIONS TYPE REF TO /AWS1/CL_GLUDATAQUALITYEVALR00 OPTIONAL
    !IT_RULESETNAMES TYPE /AWS1/CL_GLURULESETNAMES_W=>TT_RULESETNAMES OPTIONAL
    !IT_ADDITIONALDATASOURCES TYPE /AWS1/CL_GLUDATASOURCE=>TT_DATASOURCEMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_glustrtdataqualityr03
  RAISING
    /AWS1/CX_GLUCONFLICTEXCEPTION
    /AWS1/CX_GLUENTITYNOTFOUNDEX
    /AWS1/CX_GLUINTERNALSERVICEEX
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLUOPERATIONTIMEOUTEX
    /AWS1/CX_GLUCLIENTEXC
    /AWS1/CX_GLUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_datasource` `TYPE REF TO /AWS1/CL_GLUDATASOURCE` `/AWS1/CL_GLUDATASOURCE`¶

The data source (Glue table) associated with this run.

`iv_role` `TYPE /AWS1/GLUROLESTRING` `/AWS1/GLUROLESTRING`¶

An IAM role supplied to encrypt the results of the run.

`it_rulesetnames` `TYPE /AWS1/CL_GLURULESETNAMES_W=>TT_RULESETNAMES` `TT_RULESETNAMES`¶

A list of ruleset names.

Optional arguments:¶

`iv_numberofworkers` `TYPE /AWS1/GLUNULLABLEINTEGER` `/AWS1/GLUNULLABLEINTEGER`¶

The number of G.1X workers to be used in the run. The default is 5.

`iv_timeout` `TYPE /AWS1/GLUTIMEOUT` `/AWS1/GLUTIMEOUT`¶

The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

`iv_clienttoken` `TYPE /AWS1/GLUHASHSTRING` `/AWS1/GLUHASHSTRING`¶

Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

`io_additionalrunoptions` `TYPE REF TO /AWS1/CL_GLUDATAQUALITYEVALR00` `/AWS1/CL_GLUDATAQUALITYEVALR00`¶

Additional run options you can specify for an evaluation run.

`it_additionaldatasources` `TYPE /AWS1/CL_GLUDATASOURCE=>TT_DATASOURCEMAP` `TT_DATASOURCEMAP`¶

A map of reference strings to additional data sources you can specify for an evaluation run.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_glustrtdataqualityr03` `/AWS1/CL_GLUSTRTDATAQUALITYR03`¶

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->strtdataqualityrlsetevalrun(
  io_additionalrunoptions = new /aws1/cl_gludataqualityevalr00(
    iv_cloudwatchmetricsenabled = ABAP_TRUE
    iv_compositeruleevalmethod = |string|
    iv_resultss3prefix = |string|
  )
  io_datasource = new /aws1/cl_gludatasource(
    io_dataqualitygluetable = new /aws1/cl_gludataqualitygluetbl(
      it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
        (
          VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
            key = |string|
            value = new /aws1/cl_glugluetbladdlopts_w( |string| )
          )
        )
      )
      iv_catalogid = |string|
      iv_connectionname = |string|
      iv_databasename = |string|
      iv_preprocessingquery = |string|
      iv_tablename = |string|
    )
    io_gluetable = new /aws1/cl_glugluetable(
      it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
        (
          VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
            key = |string|
            value = new /aws1/cl_glugluetbladdlopts_w( |string| )
          )
        )
      )
      iv_catalogid = |string|
      iv_connectionname = |string|
      iv_databasename = |string|
      iv_tablename = |string|
    )
  )
  it_additionaldatasources = VALUE /aws1/cl_gludatasource=>tt_datasourcemap(
    (
      VALUE /aws1/cl_gludatasource=>ts_datasourcemap_maprow(
        value = new /aws1/cl_gludatasource(
          io_dataqualitygluetable = new /aws1/cl_gludataqualitygluetbl(
            it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
              (
                VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
                  key = |string|
                  value = new /aws1/cl_glugluetbladdlopts_w( |string| )
                )
              )
            )
            iv_catalogid = |string|
            iv_connectionname = |string|
            iv_databasename = |string|
            iv_preprocessingquery = |string|
            iv_tablename = |string|
          )
          io_gluetable = new /aws1/cl_glugluetable(
            it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
              (
                VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
                  key = |string|
                  value = new /aws1/cl_glugluetbladdlopts_w( |string| )
                )
              )
            )
            iv_catalogid = |string|
            iv_connectionname = |string|
            iv_databasename = |string|
            iv_tablename = |string|
          )
        )
        key = |string|
      )
    )
  )
  it_rulesetnames = VALUE /aws1/cl_glurulesetnames_w=>tt_rulesetnames(
    ( new /aws1/cl_glurulesetnames_w( |string| ) )
  )
  iv_clienttoken = |string|
  iv_numberofworkers = 123
  iv_role = |string|
  iv_timeout = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_hashstring = lo_result->get_runid( ).
ENDIF.

/AWS1/IF_GLU=>STRTDATAQUALITYRLSETEVALRUN()¶

About StartDataQualityRulesetEvaluationRun¶

Method Signature¶

IMPORTING¶

Required arguments:¶

io_datasource TYPE REF TO /AWS1/CL_GLUDATASOURCE /AWS1/CL_GLUDATASOURCE¶

iv_role TYPE /AWS1/GLUROLESTRING /AWS1/GLUROLESTRING¶

it_rulesetnames TYPE /AWS1/CL_GLURULESETNAMES_W=>TT_RULESETNAMES TT_RULESETNAMES¶