Skip to content

/AWS1/IF_TBD=>CREATEBUDGET()

About CreateBudget

Creates a budget to set spending thresholds for your rendering activity.

Method Signature

METHODS /AWS1/IF_TBD~CREATEBUDGET
  IMPORTING
    !IV_FARMID TYPE /AWS1/TBDFARMID OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/TBDRESOURCENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/TBDDESCRIPTION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/TBDCLIENTTOKEN OPTIONAL
    !IO_USAGETRACKINGRESOURCE TYPE REF TO /AWS1/CL_TBDUSAGETRKRESOURCE OPTIONAL
    !IV_APPROXIMATEDOLLARLIMIT TYPE /AWS1/RT_FLOAT_AS_STRING OPTIONAL
    !IT_ACTIONS TYPE /AWS1/CL_TBDBUDGETACTIONTOADD=>TT_BUDGETACTIONSTOADD OPTIONAL
    !IO_SCHEDULE TYPE REF TO /AWS1/CL_TBDBUDGETSCHEDULE OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_TBDTAGS_W=>TT_TAGS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_tbdcreatebudgetrsp
  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 to include in this budget.

iv_displayname TYPE /AWS1/TBDRESOURCENAME /AWS1/TBDRESOURCENAME

The display name of the budget.

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.

io_usagetrackingresource TYPE REF TO /AWS1/CL_TBDUSAGETRKRESOURCE /AWS1/CL_TBDUSAGETRKRESOURCE

The queue ID provided to this budget to track usage.

iv_approximatedollarlimit TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

The dollar limit based on consumed usage.

it_actions TYPE /AWS1/CL_TBDBUDGETACTIONTOADD=>TT_BUDGETACTIONSTOADD TT_BUDGETACTIONSTOADD

The budget actions to specify what happens when the budget runs out.

io_schedule TYPE REF TO /AWS1/CL_TBDBUDGETSCHEDULE /AWS1/CL_TBDBUDGETSCHEDULE

The schedule to associate with this budget.

Optional arguments:

iv_description TYPE /AWS1/TBDDESCRIPTION /AWS1/TBDDESCRIPTION

The description of the budget.

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_clienttoken TYPE /AWS1/TBDCLIENTTOKEN /AWS1/TBDCLIENTTOKEN

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

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_tbdcreatebudgetrsp /AWS1/CL_TBDCREATEBUDGETRSP

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->createbudget(
  io_schedule = new /aws1/cl_tbdbudgetschedule(
    io_fixed = new /aws1/cl_tbdfixedbudgetschd(
      iv_endtime = '20150101000000.0000000'
      iv_starttime = '20150101000000.0000000'
    )
  )
  io_usagetrackingresource = new /aws1/cl_tbdusagetrkresource( |string| )
  it_actions = VALUE /aws1/cl_tbdbudgetactiontoadd=>tt_budgetactionstoadd(
    (
      new /aws1/cl_tbdbudgetactiontoadd(
        iv_description = |string|
        iv_thresholdpercentage = '0.1'
        iv_type = |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_approximatedollarlimit = |0.1|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_displayname = |string|
  iv_farmid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_budgetid = lo_result->get_budgetid( ).
ENDIF.