/AWS1/IF_TBD=>SEARCHWORKERS()

About SearchWorkers

Searches for workers.

Method Signature

METHODS /AWS1/IF_TBD~SEARCHWORKERS
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IO_FILTEREXPRESSIONS TYPE REF TO /AWS1/CL_TBDSRCHGREDFILTXPRS OPTIONAL
    !IT_SORTEXPRESSIONS TYPE /AWS1/CL_TBDSEARCHSORTXPRSN=>TT_SEARCHSORTEXPRESSIONS OPTIONAL
    !IV_ITEMOFFSET TYPE /AWS1/TBDINTEGER OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/TBDINTEGER OPTIONAL
    !IT_FLEETIDS TYPE /AWS1/CL_TBDFLEETIDS_W=>TT_FLEETIDS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdsearchworkersrsp
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDRESOURCENOTFOUNDEX
    /AWS1/CX_TBDTHROTTLINGEX
    /AWS1/CX_TBDVALIDATIONEX
    /AWS1/CX_TBDCLIENTEXC
    /AWS1/CX_TBDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_farmid TYPE /AWS1/TBDFARMID /AWS1/TBDFARMID

The farm ID in the workers search.

iv_itemoffset TYPE /AWS1/TBDINTEGER /AWS1/TBDINTEGER

The offset for the search results.

it_fleetids TYPE /AWS1/CL_TBDFLEETIDS_W=>TT_FLEETIDS TT_FLEETIDS

The fleet ID of the workers to search for.

Optional arguments:

io_filterexpressions TYPE REF TO /AWS1/CL_TBDSRCHGREDFILTXPRS /AWS1/CL_TBDSRCHGREDFILTXPRS

The search terms for a resource.

it_sortexpressions TYPE /AWS1/CL_TBDSEARCHSORTXPRSN=>TT_SEARCHSORTEXPRESSIONS TT_SEARCHSORTEXPRESSIONS

The search terms for a resource.

iv_pagesize TYPE /AWS1/TBDINTEGER /AWS1/TBDINTEGER

Specifies the number of results to return.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdsearchworkersrsp /AWS1/CL_TBDSEARCHWORKERSRSP

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->searchworkers(
  io_filterexpressions = new /aws1/cl_tbdsrchgredfiltxprs(
    it_filters = VALUE /aws1/cl_tbdsearchfilterxprsn=>tt_searchfilterexpressions(
      (
        new /aws1/cl_tbdsearchfilterxprsn(
          io_datetimefilter = new /aws1/cl_tbddatetimefiltxprsn(
            iv_datetime = '20150101000000.0000000'
            iv_name = |string|
            iv_operator = |string|
          )
          io_groupfilter = new /aws1/cl_tbdsrchgredfiltxprs( iv_operator = |string| )
          io_parameterfilter = new /aws1/cl_tbdparamfilterxprsn(
            iv_name = |string|
            iv_operator = |string|
            iv_value = |string|
          )
          io_searchtermfilter = new /aws1/cl_tbdsrchtermfiltxprsn(
            iv_matchtype = |string|
            iv_searchterm = |string|
          )
          io_stringfilter = new /aws1/cl_tbdstringfilterxprsn(
            iv_name = |string|
            iv_operator = |string|
            iv_value = |string|
          )
          io_stringlistfilter = new /aws1/cl_tbdstrlistfilterxprsn(
            it_values = VALUE /aws1/cl_tbdstringfilterlist_w=>tt_stringfilterlist(
              ( new /aws1/cl_tbdstringfilterlist_w( |string| ) )
            )
            iv_name = |string|
            iv_operator = |string|
          )
        )
      )
    )
    iv_operator = |string|
  )
  it_fleetids = VALUE /aws1/cl_tbdfleetids_w=>tt_fleetids(
    ( new /aws1/cl_tbdfleetids_w( |string| ) )
  )
  it_sortexpressions = VALUE /aws1/cl_tbdsearchsortxprsn=>tt_searchsortexpressions(
    (
      new /aws1/cl_tbdsearchsortxprsn(
        io_fieldsort = new /aws1/cl_tbdfieldsortxprsn(
          iv_name = |string|
          iv_sortorder = |string|
        )
        io_parametersort = new /aws1/cl_tbdparametersortxprsn(
          iv_name = |string|
          iv_sortorder = |string|
        )
        io_userjobsfirst = new /aws1/cl_tbduserjobsfirst( |string| )
      )
    )
  )
  iv_farmid = |string|
  iv_itemoffset = 123
  iv_pagesize = 123
).

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_workers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_fleetid = lo_row_1->get_fleetid( ).
      lv_workerid = lo_row_1->get_workerid( ).
      lv_workerstatus = lo_row_1->get_status( ).
      lo_hostpropertiesresponse = lo_row_1->get_hostproperties( ).
      IF lo_hostpropertiesresponse IS NOT INITIAL.
        lo_ipaddresses = lo_hostpropertiesresponse->get_ipaddresses( ).
        IF lo_ipaddresses IS NOT INITIAL.
          LOOP AT lo_ipaddresses->get_ipv4addresses( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_ipv4address = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_ipaddresses->get_ipv6addresses( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_ipv6address = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        lv_hostname = lo_hostpropertiesresponse->get_hostname( ).
        lv_string = lo_hostpropertiesresponse->get_ec2instancearn( ).
        lv_instancetype = lo_hostpropertiesresponse->get_ec2instancetype( ).
      ENDIF.
      lv_createdby = lo_row_1->get_createdby( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_nextitemoffset = lo_result->get_nextitemoffset( ).
  lv_totalresults = lo_result->get_totalresults( ).
ENDIF.