GETCANARYRUNS()`¶

About GetCanaryRuns¶

Retrieves a list of runs for a specified canary.

Method Signature¶

METHODS /AWS1/IF_SYN~GETCANARYRUNS
  IMPORTING
    !IV_NAME TYPE /AWS1/SYNCANARYNAME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SYNTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SYNMAXSIZE100 OPTIONAL
    !IV_DRYRUNID TYPE /AWS1/SYNUUID OPTIONAL
    !IV_RUNTYPE TYPE /AWS1/SYNRUNTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_syngetcanaryrunsrsp
  RAISING
    /AWS1/CX_SYNINTERNALSERVEREX
    /AWS1/CX_SYNRESOURCENOTFOUNDEX
    /AWS1/CX_SYNVALIDATIONEX
    /AWS1/CX_SYNCLIENTEXC
    /AWS1/CX_SYNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/SYNCANARYNAME` `/AWS1/SYNCANARYNAME`¶

The name of the canary that you want to see runs for.

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/SYNTOKEN` `/AWS1/SYNTOKEN`¶

A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

When auto retry is enabled for the canary, the first subsequent retry is suffixed with 1 indicating its the first retry and the next subsequent try is suffixed with 2.

`iv_maxresults` `TYPE /AWS1/SYNMAXSIZE100` `/AWS1/SYNMAXSIZE100`¶

Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

`iv_dryrunid` `TYPE /AWS1/SYNUUID` `/AWS1/SYNUUID`¶

The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

`iv_runtype` `TYPE /AWS1/SYNRUNTYPE` `/AWS1/SYNRUNTYPE`¶

When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

When a value is not provided for RunType, the default value is CANARY_RUN

When CANARY_RUN is provided, all canary runs excluding dry runs are returned

When DRY_RUN is provided, all dry runs excluding canary runs are returned

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_syngetcanaryrunsrsp` `/AWS1/CL_SYNGETCANARYRUNSRSP`¶

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->getcanaryruns(
  iv_dryrunid = |string|
  iv_maxresults = 123
  iv_name = |string|
  iv_nexttoken = |string|
  iv_runtype = |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_canaryruns( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_uuid = lo_row_1->get_id( ).
      lv_uuid = lo_row_1->get_scheduledrunid( ).
      lv_retryattempt = lo_row_1->get_retryattempt( ).
      lv_canaryname = lo_row_1->get_name( ).
      lo_canaryrunstatus = lo_row_1->get_status( ).
      IF lo_canaryrunstatus IS NOT INITIAL.
        lv_canaryrunstate = lo_canaryrunstatus->get_state( ).
        lv_string = lo_canaryrunstatus->get_statereason( ).
        lv_canaryrunstatereasoncod = lo_canaryrunstatus->get_statereasoncode( ).
        lv_canaryruntestresult = lo_canaryrunstatus->get_testresult( ).
      ENDIF.
      lo_canaryruntimeline = lo_row_1->get_timeline( ).
      IF lo_canaryruntimeline IS NOT INITIAL.
        lv_timestamp = lo_canaryruntimeline->get_started( ).
        lv_timestamp = lo_canaryruntimeline->get_completed( ).
        lv_timestamp = lo_canaryruntimeline->get_metrictsmpforrunandret00( ).
      ENDIF.
      lv_string = lo_row_1->get_artifacts3location( ).
      lo_canarydryrunconfigoutpu = lo_row_1->get_dryrunconfig( ).
      IF lo_canarydryrunconfigoutpu IS NOT INITIAL.
        lv_uuid = lo_canarydryrunconfigoutpu->get_dryrunid( ).
      ENDIF.
      lv_browsertype = lo_row_1->get_browsertype( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_SYN=>GETCANARYRUNS()¶