Skip to content

/AWS1/IF_SGM=>LISTMONITORINGSCHEDULES()

About ListMonitoringSchedules

Returns list of all monitoring schedules.

Method Signature

METHODS /AWS1/IF_SGM~LISTMONITORINGSCHEDULES
  IMPORTING
    !IV_ENDPOINTNAME TYPE /AWS1/SGMENDPOINTNAME OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMMONSCHEDULESORTKEY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMSCHEDULESTATUS OPTIONAL
    !IV_MONJOBDEFINITIONNAME TYPE /AWS1/SGMMONJOBDEFINITIONNAME OPTIONAL
    !IV_MONITORINGTYPEEQUALS TYPE /AWS1/SGMMONITORINGTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlistmonschdsrsp
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_endpointname TYPE /AWS1/SGMENDPOINTNAME /AWS1/SGMENDPOINTNAME

Name of a specific endpoint to fetch schedules for.

iv_sortby TYPE /AWS1/SGMMONSCHEDULESORTKEY /AWS1/SGMMONSCHEDULESORTKEY

Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

Whether to sort the results in Ascending or Descending order. The default is Descending.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of jobs to return in the response. The default value is 10.

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

Filter for monitoring schedules whose name contains a specified string.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only monitoring schedules created before a specified time.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only monitoring schedules created after a specified time.

iv_lastmodifiedtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only monitoring schedules modified before a specified time.

iv_lastmodifiedtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only monitoring schedules modified after a specified time.

iv_statusequals TYPE /AWS1/SGMSCHEDULESTATUS /AWS1/SGMSCHEDULESTATUS

A filter that returns only monitoring schedules modified before a specified time.

iv_monjobdefinitionname TYPE /AWS1/SGMMONJOBDEFINITIONNAME /AWS1/SGMMONJOBDEFINITIONNAME

Gets a list of the monitoring schedules for the specified monitoring job definition.

iv_monitoringtypeequals TYPE /AWS1/SGMMONITORINGTYPE /AWS1/SGMMONITORINGTYPE

A filter that returns only the monitoring schedules for the specified monitoring type.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlistmonschdsrsp /AWS1/CL_SGMLISTMONSCHDSRSP

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->listmonitoringschedules(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_endpointname = |string|
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_monitoringtypeequals = |string|
  iv_monjobdefinitionname = |string|
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |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_monschedulesummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_monitoringschedulename = lo_row_1->get_monitoringschedulename( ).
      lv_monitoringschedulearn = lo_row_1->get_monitoringschedulearn( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lv_schedulestatus = lo_row_1->get_monitoringschedulestatus( ).
      lv_endpointname = lo_row_1->get_endpointname( ).
      lv_monitoringjobdefinition = lo_row_1->get_monjobdefinitionname( ).
      lv_monitoringtype = lo_row_1->get_monitoringtype( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.