/AWS1/IF_TBD=>CREATEQUEUE()

About CreateQueue

Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.

Method Signature

METHODS /AWS1/IF_TBD~CREATEQUEUE
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IV_FARMID TYPE /AWS1/TBDFARMID 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_REQUIREDFILESYSTEMLOCNA00 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES OPTIONAL
    !IT_ALLOWEDSTORAGEPROFILEIDS TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TBDTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdcreatequeuersp
  RAISING
    /AWS1/CX_TBDACCESSDENIEDEX
    /AWS1/CX_TBDINTERNALSERVERER00
    /AWS1/CX_TBDRESOURCENOTFOUNDEX
    /AWS1/CX_TBDSERVICEQUOTAEXCDEX
    /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 to connect to the queue.

iv_displayname TYPE /AWS1/TBDRESOURCENAME /AWS1/TBDRESOURCENAME

The display name of the queue.

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.

Optional arguments:

iv_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

The unique token which the server uses to recognize retries of the same request.

iv_description TYPE /AWS1/TBDDESCRIPTION /AWS1/TBDDESCRIPTION

The description of the queue.

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 on a queue if a budget isn't configured.

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

The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.

iv_rolearn TYPE /AWS1/TBDIAMROLEARN /AWS1/TBDIAMROLEARN

The IAM role ARN that workers will use while running jobs for this queue.

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

The jobs in the queue run as the specified POSIX user.

it_requiredfilesystemlocna00 TYPE /AWS1/CL_TBDREQUIREDFILESYST00=>TT_REQUIREDFILESYSTEMLOCNAMES TT_REQUIREDFILESYSTEMLOCNAMES

The file system location name to include in the queue.

it_allowedstorageprofileids TYPE /AWS1/CL_TBDALWEDSTRGPFLIDS_W=>TT_ALLOWEDSTORAGEPROFILEIDS TT_ALLOWEDSTORAGEPROFILEIDS

The storage profile IDs to include in the queue.

it_tags TYPE /AWS1/CL_TBDTAGS_W=>TT_TAGS TT_TAGS

Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdcreatequeuersp /AWS1/CL_TBDCREATEQUEUERSP

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->createqueue(
  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|
  )
  it_allowedstorageprofileids = VALUE /aws1/cl_tbdalwedstrgpflids_w=>tt_allowedstorageprofileids(
    ( new /aws1/cl_tbdalwedstrgpflids_w( |string| ) )
  )
  it_requiredfilesystemlocna00 = VALUE /aws1/cl_tbdrequiredfilesyst00=>tt_requiredfilesystemlocnames(
    ( new /aws1/cl_tbdrequiredfilesyst00( |string| ) )
  )
  it_tags = VALUE /aws1/cl_tbdtags_w=>tt_tags(
    (
      VALUE /aws1/cl_tbdtags_w=>ts_tags_maprow(
        value = new /aws1/cl_tbdtags_w( |string| )
        key = |string|
      )
    )
  )
  iv_clienttoken = |string|
  iv_defaultbudgetaction = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_farmid = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_queueid = lo_result->get_queueid( ).
ENDIF.