LISTQUEUES()`¶

About ListQueues¶

Lists queues.

Method Signature¶

METHODS /AWS1/IF_TBD~LISTQUEUES
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_PRINCIPALID TYPE /AWS1/TBDIDENTITYCENTERPRINCID OPTIONAL
    !IV_STATUS TYPE /AWS1/TBDQUEUESTATUS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/TBDSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/TBDMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdlistqueuesresponse
  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 of the queue.

Optional arguments:¶

`iv_principalid` `TYPE /AWS1/TBDIDENTITYCENTERPRINCID` `/AWS1/TBDIDENTITYCENTERPRINCID`¶

The principal IDs to include in the list of queues.

`iv_status` `TYPE /AWS1/TBDQUEUESTATUS` `/AWS1/TBDQUEUESTATUS`¶

The status of the queues listed.

ACTIVE–The queues are active.

SCHEDULING–The queues are scheduling.

SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.

`iv_nexttoken` `TYPE /AWS1/TBDSTRING` `/AWS1/TBDSTRING`¶

The token for the next set of results, or null to start from the beginning.

`iv_maxresults` `TYPE /AWS1/TBDMAXRESULTS` `/AWS1/TBDMAXRESULTS`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_tbdlistqueuesresponse` `/AWS1/CL_TBDLISTQUEUESRESPONSE`¶

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->listqueues(
  iv_farmid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_principalid = |string|
  iv_status = |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_queues( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_farmid = lo_row_1->get_farmid( ).
      lv_queueid = lo_row_1->get_queueid( ).
      lv_resourcename = lo_row_1->get_displayname( ).
      lv_queuestatus = lo_row_1->get_status( ).
      lv_defaultqueuebudgetactio = lo_row_1->get_defaultbudgetaction( ).
      lv_queueblockedreason = lo_row_1->get_blockedreason( ).
      lv_createdat = lo_row_1->get_createdat( ).
      lv_createdby = lo_row_1->get_createdby( ).
      lv_updatedat = lo_row_1->get_updatedat( ).
      lv_updatedby = lo_row_1->get_updatedby( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_TBD=>LISTQUEUES()¶