Skip to content

/AWS1/IF_TBD=>CREATEQUEUEENVIRONMENT()

About CreateQueueEnvironment

Creates an environment for a queue that defines how jobs in the queue run.

Method Signature

METHODS /AWS1/IF_TBD~CREATEQUEUEENVIRONMENT
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_QUEUEID TYPE /AWS1/TBDQUEUEID OPTIONAL
    !IV_PRIORITY TYPE /AWS1/TBDPRIORITY OPTIONAL
    !IV_TEMPLATETYPE TYPE /AWS1/TBDENVIRONMENTTMPLTYPE OPTIONAL
    !IV_TEMPLATE TYPE /AWS1/TBDENVIRONMENTTEMPLATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdcrequeueenvironm01
  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 environment.

iv_queueid TYPE /AWS1/TBDQUEUEID /AWS1/TBDQUEUEID

The queue ID to connect the queue and environment.

iv_priority TYPE /AWS1/TBDPRIORITY /AWS1/TBDPRIORITY

Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority (activated first and deactivated last). If two environments share the same priority value, the environment created first takes higher priority.

iv_templatetype TYPE /AWS1/TBDENVIRONMENTTMPLTYPE /AWS1/TBDENVIRONMENTTMPLTYPE

The template's file type, JSON or YAML.

iv_template TYPE /AWS1/TBDENVIRONMENTTEMPLATE /AWS1/TBDENVIRONMENTTEMPLATE

The environment template to use in the queue.

Optional arguments:

iv_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

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

RETURNING

oo_output TYPE REF TO /aws1/cl_tbdcrequeueenvironm01 /AWS1/CL_TBDCREQUEUEENVIRONM01

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->createqueueenvironment(
  iv_clienttoken = |string|
  iv_farmid = |string|
  iv_priority = 123
  iv_queueid = |string|
  iv_template = |string|
  iv_templatetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_queueenvironmentid = lo_result->get_queueenvironmentid( ).
ENDIF.