Skip to content

/AWS1/IF_SGM=>LISTOPTIMIZATIONJOBS()

About ListOptimizationJobs

Lists the optimization jobs in your account and their properties.

Method Signature

METHODS /AWS1/IF_SGM~LISTOPTIMIZATIONJOBS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMCREATIONTIME OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMCREATIONTIME OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMLASTMODIFIEDTIME OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMLASTMODIFIEDTIME OPTIONAL
    !IV_OPTIMIZATIONCONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMOPTIMIZATIONJOBSTATUS OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMLSTOPTIMIZATIONJOBS00 OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlstoptimizationj01
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of optimization jobs to return in the response. The default is 50.

iv_creationtimeafter TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

Filters the results to only those optimization jobs that were created after the specified time.

iv_creationtimebefore TYPE /AWS1/SGMCREATIONTIME /AWS1/SGMCREATIONTIME

Filters the results to only those optimization jobs that were created before the specified time.

iv_lastmodifiedtimeafter TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

Filters the results to only those optimization jobs that were updated after the specified time.

iv_lastmodifiedtimebefore TYPE /AWS1/SGMLASTMODIFIEDTIME /AWS1/SGMLASTMODIFIEDTIME

Filters the results to only those optimization jobs that were updated before the specified time.

iv_optimizationcontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

Filters the results to only those optimization jobs that apply the specified optimization techniques. You can specify either Quantization or Compilation.

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

Filters the results to only those optimization jobs with a name that contains the specified string.

iv_statusequals TYPE /AWS1/SGMOPTIMIZATIONJOBSTATUS /AWS1/SGMOPTIMIZATIONJOBSTATUS

Filters the results to only those optimization jobs with the specified status.

iv_sortby TYPE /AWS1/SGMLSTOPTIMIZATIONJOBS00 /AWS1/SGMLSTOPTIMIZATIONJOBS00

The field by which to sort the optimization jobs in the response. The default is CreationTime

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for results. The default is Ascending

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlstoptimizationj01 /AWS1/CL_SGMLSTOPTIMIZATIONJ01

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->listoptimizationjobs(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_optimizationcontains = |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_optimizationjobsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityname = lo_row_1->get_optimizationjobname( ).
      lv_optimizationjobarn = lo_row_1->get_optimizationjobarn( ).
      lv_creationtime = lo_row_1->get_creationtime( ).
      lv_optimizationjobstatus = lo_row_1->get_optimizationjobstatus( ).
      lv_timestamp = lo_row_1->get_optimizationstarttime( ).
      lv_timestamp = lo_row_1->get_optimizationendtime( ).
      lv_lastmodifiedtime = lo_row_1->get_lastmodifiedtime( ).
      lv_optimizationjobdeployme = lo_row_1->get_deploymentinstancetype( ).
      LOOP AT lo_row_1->get_optimizationtypes( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_optimizationtype = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.