/AWS1/IF_TBD=>GETQUEUE()

About GetQueue

Gets a queue.

Method Signature

METHODS /AWS1/IF_TBD~GETQUEUE
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_QUEUEID TYPE /AWS1/TBDQUEUEID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdgetqueueresponse
  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 farm in the queue.

iv_queueid TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID

The queue ID for the queue to retrieve.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdgetqueueresponse /AWS1/CL_TBDGETQUEUERESPONSE

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->getqueue(
  iv_farmid = |string|
  iv_queueid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_farmid = lo_result->get_farmid( ).
  lv_queueid = lo_result->get_queueid( ).
  lv_resourcename = lo_result->get_displayname( ).
  lv_queuestatus = lo_result->get_status( ).
  lv_defaultqueuebudgetactio = lo_result->get_defaultbudgetaction( ).
  lv_queueblockedreason = lo_result->get_blockedreason( ).
  lv_createdat = lo_result->get_createdat( ).
  lv_createdby = lo_result->get_createdby( ).
  lv_updatedat = lo_result->get_updatedat( ).
  lv_updatedby = lo_result->get_updatedby( ).
  lv_description = lo_result->get_description( ).
  lo_jobattachmentsettings = lo_result->get_jobattachmentsettings( ).
  IF lo_jobattachmentsettings IS NOT INITIAL.
    lv_s3bucketname = lo_jobattachmentsettings->get_s3bucketname( ).
    lv_s3prefix = lo_jobattachmentsettings->get_rootprefix( ).
  ENDIF.
  lv_iamrolearn = lo_result->get_rolearn( ).
  LOOP AT lo_result->get_requiredfilesystemlocn00( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_filesystemlocationname = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_allowedstorageprofileids( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_storageprofileid = lo_row_3->get_value( ).
    ENDIF.
  ENDLOOP.
  lo_jobrunasuser = lo_result->get_jobrunasuser( ).
  IF lo_jobrunasuser IS NOT INITIAL.
    lo_posixuser = lo_jobrunasuser->get_posix( ).
    IF lo_posixuser IS NOT INITIAL.
      lv_string = lo_posixuser->get_user( ).
      lv_string = lo_posixuser->get_group( ).
    ENDIF.
    lo_windowsuser = lo_jobrunasuser->get_windows( ).
    IF lo_windowsuser IS NOT INITIAL.
      lv_string = lo_windowsuser->get_user( ).
      lv_string = lo_windowsuser->get_passwordarn( ).
    ENDIF.
    lv_runas = lo_jobrunasuser->get_runas( ).
  ENDIF.
  lo_schedulingconfiguration = lo_result->get_schedulingconfiguration( ).
  IF lo_schedulingconfiguration IS NOT INITIAL.
    lo_priorityfifoschedulingc = lo_schedulingconfiguration->get_priorityfifo( ).
    IF lo_priorityfifoschedulingc IS NOT INITIAL.
    ENDIF.
    lo_prioritybalancedschedul = lo_schedulingconfiguration->get_prioritybalanced( ).
    IF lo_prioritybalancedschedul IS NOT INITIAL.
      lv_schedulingrenderingtask = lo_prioritybalancedschedul->get_renderingtaskbuffer( ).
    ENDIF.
    lo_weightedbalancedschedul = lo_schedulingconfiguration->get_weightedbalanced( ).
    IF lo_weightedbalancedschedul IS NOT INITIAL.
      lv_schedulingpriorityweigh = lo_weightedbalancedschedul->get_priorityweight( ).
      lv_schedulingerrorweight = lo_weightedbalancedschedul->get_errorweight( ).
      lv_schedulingsubmissiontim = lo_weightedbalancedschedul->get_submissiontimeweight( ).
      lv_schedulingrenderingtask_1 = lo_weightedbalancedschedul->get_renderingtaskweight( ).
      lv_schedulingrenderingtask = lo_weightedbalancedschedul->get_renderingtaskbuffer( ).
      lo_schedulingmaxpriorityov = lo_weightedbalancedschedul->get_maxpriorityoverride( ).
      IF lo_schedulingmaxpriorityov IS NOT INITIAL.
        lo_schedulingmaxpriorityov_1 = lo_schedulingmaxpriorityov->get_alwaysschedulefirst( ).
        IF lo_schedulingmaxpriorityov_1 IS NOT INITIAL.
        ENDIF.
      ENDIF.
      lo_schedulingminpriorityov = lo_weightedbalancedschedul->get_minpriorityoverride( ).
      IF lo_schedulingminpriorityov IS NOT INITIAL.
        lo_schedulingminpriorityov_1 = lo_schedulingminpriorityov->get_alwaysschedulelast( ).
        IF lo_schedulingminpriorityov_1 IS NOT INITIAL.
        ENDIF.
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.