Skip to content

/AWS1/IF_TBD=>UPDATEQUEUE()

About UpdateQueue

Updates a queue.

Method Signature

METHODS /AWS1/IF_TBD~UPDATEQUEUE
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_QUEUEID TYPE /AWS1/TBDQUEUEID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/TBDRESOURCENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/TBDDESCRIPTION OPTIONAL
    !IV_DEFAULTBUDGETACTION TYPE /AWS1/TBDDEFQUEUEBUDGETACTION OPTIONAL
    !IO_JOBATTACHMENTSETTINGS TYPE REF TO /AWS1/CL_TBDJOBATTACHMENTSTGS OPTIONAL
    !IV_ROLEARN TYPE /AWS1/TBDIAMROLEARN OPTIONAL
    !IO_JOBRUNASUSER TYPE REF TO /AWS1/CL_TBDJOBRUNASUSER OPTIONAL
    !IT_REQUIREDFILESYSTEMLOCNA01 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES OPTIONAL
    !IT_REQUIREDFILESYSTEMLOCNA02 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES OPTIONAL
    !IT_ALLOWEDSTORAGEPFLIDSTOADD TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS OPTIONAL
    !IT_ALLOWEDSTRGPFLIDSTOREMOVE TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS OPTIONAL
    !IO_SCHEDULINGCONFIGURATION TYPE REF TO /AWS1/CL_TBDSCHEDULINGCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdupdatequeuersp
  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 to update in the queue.

iv_queueid TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID

The queue ID to update.

Optional arguments:

iv_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

The idempotency token to update in the queue.

iv_displayname TYPE /AWS1/TBDRESOURCENAME /AWS1/TBDRESOURCENAME

The display name of the queue to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

iv_description TYPE /AWS1/TBDDESCRIPTION /AWS1/TBDDESCRIPTION

The description of the queue to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

iv_defaultbudgetaction TYPE /AWS1/TBDDEFQUEUEBUDGETACTION /AWS1/TBDDEFQUEUEBUDGETACTION

The default action to take for a queue update if a budget isn't configured.

io_jobattachmentsettings TYPE REF TO /AWS1/CL_TBDJOBATTACHMENTSTGS /AWS1/CL_TBDJOBATTACHMENTSTGS

The job attachment settings to update for the queue.

iv_rolearn TYPE /AWS1/TBDIAMROLEARN /AWS1/TBDIAMROLEARN

The IAM role ARN that's used to run jobs from this queue.

io_jobrunasuser TYPE REF TO /AWS1/CL_TBDJOBRUNASUSER /AWS1/CL_TBDJOBRUNASUSER

Update the jobs in the queue to run as a specified POSIX user.

it_requiredfilesystemlocna01 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES TT_REQUIREDFILESYSTEMLOCNAMES

The required file system location names to add to the queue.

it_requiredfilesystemlocna02 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES TT_REQUIREDFILESYSTEMLOCNAMES

The required file system location names to remove from the queue.

it_allowedstoragepflidstoadd TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS TT_ALLOWEDSTORAGEPROFILEIDS

The storage profile IDs to add.

it_allowedstrgpflidstoremove TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS TT_ALLOWEDSTORAGEPROFILEIDS

The storage profile ID to remove.

io_schedulingconfiguration TYPE REF TO /AWS1/CL_TBDSCHEDULINGCONF /AWS1/CL_TBDSCHEDULINGCONF

The scheduling configuration for the queue. This configuration determines how workers are assigned to jobs in the queue.

When updating the scheduling configuration, the entire configuration is replaced.

In-progress tasks run to completion before the new scheduling configuration takes effect.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdupdatequeuersp /AWS1/CL_TBDUPDATEQUEUERSP

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->updatequeue(
  io_jobattachmentsettings = new /aws1/cl_tbdjobattachmentstgs(
    iv_rootprefix = |string|
    iv_s3bucketname = |string|
  )
  io_jobrunasuser = new /aws1/cl_tbdjobrunasuser(
    io_posix = new /aws1/cl_tbdposixuser(
      iv_group = |string|
      iv_user = |string|
    )
    io_windows = new /aws1/cl_tbdwindowsuser(
      iv_passwordarn = |string|
      iv_user = |string|
    )
    iv_runas = |string|
  )
  io_schedulingconfiguration = new /aws1/cl_tbdschedulingconf(
    io_prioritybalanced = new /aws1/cl_tbdpribalschdconf( 123 )
    io_priorityfifo = new /aws1/cl_tbdprififoschdconf( )
    io_weightedbalanced = new /aws1/cl_tbdwtblncdschdlngconf(
      io_maxpriorityoverride = new /aws1/cl_tbdschdlngmaxprioovrd( new /aws1/cl_tbdschmaxprovralwsc00( ) )
      io_minpriorityoverride = new /aws1/cl_tbdschdlngminprioovrd( new /aws1/cl_tbdschminprovralwsc00( ) )
      iv_errorweight = '0.1'
      iv_priorityweight = '0.1'
      iv_renderingtaskbuffer = 123
      iv_renderingtaskweight = '0.1'
      iv_submissiontimeweight = '0.1'
    )
  )
  it_allowedstoragepflidstoadd = VALUE /aws1/cl_tbdalwedstrgpflids_w=>tt_allowedstorageprofileids(
    ( new /aws1/cl_tbdalwedstrgpflids_w( |string| ) )
  )
  it_allowedstrgpflidstoremove = VALUE /aws1/cl_tbdalwedstrgpflids_w=>tt_allowedstorageprofileids(
    ( new /aws1/cl_tbdalwedstrgpflids_w( |string| ) )
  )
  it_requiredfilesystemlocna01 = VALUE /aws1/cl_tbdrequiredfilesyst00=>tt_requiredfilesystemlocnames(
    ( new /aws1/cl_tbdrequiredfilesyst00( |string| ) )
  )
  it_requiredfilesystemlocna02 = VALUE /aws1/cl_tbdrequiredfilesyst00=>tt_requiredfilesystemlocnames(
    ( new /aws1/cl_tbdrequiredfilesyst00( |string| ) )
  )
  iv_clienttoken = |string|
  iv_defaultbudgetaction = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_farmid = |string|
  iv_queueid = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.