DESCRIBEEVENTS()`¶

About DescribeEvents¶

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Method Signature¶

METHODS /AWS1/IF_OWC~DESCRIBEEVENTS
  IMPORTING
    !IV_SERVERNAME TYPE /AWS1/OWCSERVERNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OWCNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OWCMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_owcdescreventsrsp
  RAISING
    /AWS1/CX_OWCINVALIDNEXTTOKENEX
    /AWS1/CX_OWCRESOURCENOTFOUNDEX
    /AWS1/CX_OWCVALIDATIONEX
    /AWS1/CX_OWCCLIENTEXC
    /AWS1/CX_OWCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_servername` `TYPE /AWS1/OWCSERVERNAME` `/AWS1/OWCSERVERNAME`¶

The name of the server for which you want to view events.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/OWCNEXTTOKEN` `/AWS1/OWCNEXTTOKEN`¶

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

`iv_maxresults` `TYPE /AWS1/OWCMAXRESULTS` `/AWS1/OWCMAXRESULTS`¶

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_owcdescreventsrsp` `/AWS1/CL_OWCDESCREVENTSRSP`¶

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->describeevents(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_servername = |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_serverevents( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_timestamp = lo_row_1->get_createdat( ).
      lv_string = lo_row_1->get_servername( ).
      lv_string = lo_row_1->get_message( ).
      lv_string = lo_row_1->get_logurl( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OWC=>DESCRIBEEVENTS()¶