DESCRIBEQUERY()`¶

About DescribeQuery¶

Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status.

You must specify either QueryId or QueryAlias. Specifying the QueryAlias parameter returns information about the last query run for the alias. You can provide RefreshId along with QueryAlias to view the query results of a dashboard query for the specified RefreshId.

Method Signature¶

METHODS /AWS1/IF_TRL~DESCRIBEQUERY
  IMPORTING
    !IV_EVENTDATASTORE TYPE /AWS1/TRLEVENTDATASTOREARN OPTIONAL
    !IV_QUERYID TYPE /AWS1/TRLUUID OPTIONAL
    !IV_QUERYALIAS TYPE /AWS1/TRLQUERYALIAS OPTIONAL
    !IV_REFRESHID TYPE /AWS1/TRLREFRESHID OPTIONAL
    !IV_EVENTDATASTOREOWNERACCTID TYPE /AWS1/TRLACCOUNTID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_trldescrqueryresponse
  RAISING
    /AWS1/CX_TRLEVTDATASTOREARNI00
    /AWS1/CX_TRLEVTDATASTORENOTF00
    /AWS1/CX_TRLINACTEVTDATASTOR00
    /AWS1/CX_TRLINVALIDPARAMETEREX
    /AWS1/CX_TRLNOMANAGEMENTACCT00
    /AWS1/CX_TRLOPNOTPERMITTEDEX
    /AWS1/CX_TRLQUERYIDNOTFOUNDEX
    /AWS1/CX_TRLUNSUPPORTEDOPEX
    /AWS1/CX_TRLCLIENTEXC
    /AWS1/CX_TRLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_eventdatastore` `TYPE /AWS1/TRLEVENTDATASTOREARN` `/AWS1/TRLEVENTDATASTOREARN`¶

The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.

`iv_queryid` `TYPE /AWS1/TRLUUID` `/AWS1/TRLUUID`¶

The query ID.

`iv_queryalias` `TYPE /AWS1/TRLQUERYALIAS` `/AWS1/TRLQUERYALIAS`¶

The alias that identifies a query template.

`iv_refreshid` `TYPE /AWS1/TRLREFRESHID` `/AWS1/TRLREFRESHID`¶

The ID of the dashboard refresh.

`iv_eventdatastoreowneracctid` `TYPE /AWS1/TRLACCOUNTID` `/AWS1/TRLACCOUNTID`¶

The account ID of the event data store owner.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_trldescrqueryresponse` `/AWS1/CL_TRLDESCRQUERYRESPONSE`¶

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->describequery(
  iv_eventdatastore = |string|
  iv_eventdatastoreowneracctid = |string|
  iv_queryalias = |string|
  iv_queryid = |string|
  iv_refreshid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uuid = lo_result->get_queryid( ).
  lv_querystatement = lo_result->get_querystring( ).
  lv_querystatus = lo_result->get_querystatus( ).
  lo_querystatisticsfordescr = lo_result->get_querystatistics( ).
  IF lo_querystatisticsfordescr IS NOT INITIAL.
    lv_long = lo_querystatisticsfordescr->get_eventsmatched( ).
    lv_long = lo_querystatisticsfordescr->get_eventsscanned( ).
    lv_long = lo_querystatisticsfordescr->get_bytesscanned( ).
    lv_integer = lo_querystatisticsfordescr->get_executiontimeinmillis( ).
    lv_date = lo_querystatisticsfordescr->get_creationtime( ).
  ENDIF.
  lv_errormessage = lo_result->get_errormessage( ).
  lv_deliverys3uri = lo_result->get_deliverys3uri( ).
  lv_deliverystatus = lo_result->get_deliverystatus( ).
  lv_prompt = lo_result->get_prompt( ).
  lv_accountid = lo_result->get_evtdatastoreowneracctid( ).
ENDIF.

/AWS1/IF_TRL=>DESCRIBEQUERY()¶