DESCRIBEDEVICE()`¶

About DescribeDevice¶

Describes the device.

Method Signature¶

METHODS /AWS1/IF_SGM~DESCRIBEDEVICE
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_DEVICENAME TYPE /AWS1/SGMENTITYNAME OPTIONAL
    !IV_DEVICEFLEETNAME TYPE /AWS1/SGMENTITYNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmdescrdevicersp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_devicename` `TYPE /AWS1/SGMENTITYNAME` `/AWS1/SGMENTITYNAME`¶

The unique ID of the device.

`iv_devicefleetname` `TYPE /AWS1/SGMENTITYNAME` `/AWS1/SGMENTITYNAME`¶

The name of the fleet the devices belong to.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SGMNEXTTOKEN` `/AWS1/SGMNEXTTOKEN`¶

Next token of device description.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmdescrdevicersp` `/AWS1/CL_SGMDESCRDEVICERSP`¶

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->describedevice(
  iv_devicefleetname = |string|
  iv_devicename = |string|
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_devicearn = lo_result->get_devicearn( ).
  lv_entityname = lo_result->get_devicename( ).
  lv_devicedescription = lo_result->get_description( ).
  lv_entityname = lo_result->get_devicefleetname( ).
  lv_thingname = lo_result->get_iotthingname( ).
  lv_timestamp = lo_result->get_registrationtime( ).
  lv_timestamp = lo_result->get_latestheartbeat( ).
  LOOP AT lo_result->get_models( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityname = lo_row_1->get_modelname( ).
      lv_edgeversion = lo_row_1->get_modelversion( ).
      lv_timestamp = lo_row_1->get_latestsampletime( ).
      lv_timestamp = lo_row_1->get_latestinference( ).
    ENDIF.
  ENDLOOP.
  lv_integer = lo_result->get_maxmodels( ).
  lv_nexttoken = lo_result->get_nexttoken( ).
  lv_edgeversion = lo_result->get_agentversion( ).
ENDIF.

/AWS1/IF_SGM=>DESCRIBEDEVICE()¶