Skip to content

/AWS1/IF_AG2=>UPDATESTAGE()

About UpdateStage

Updates a Stage.

Method Signature

METHODS /AWS1/IF_AG2~UPDATESTAGE
  IMPORTING
    !IO_ACCESSLOGSETTINGS TYPE REF TO /AWS1/CL_AG2ACCESSLOGSETTINGS OPTIONAL
    !IV_APIID TYPE /AWS1/AG2__STRING OPTIONAL
    !IV_AUTODEPLOY TYPE /AWS1/AG2__BOOLEAN OPTIONAL
    !IV_CLIENTCERTIFICATEID TYPE /AWS1/AG2ID OPTIONAL
    !IO_DEFAULTROUTESETTINGS TYPE REF TO /AWS1/CL_AG2ROUTESETTINGS OPTIONAL
    !IV_DEPLOYMENTID TYPE /AWS1/AG2ID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/AG2STRWLENGTHBETWEEN0A00 OPTIONAL
    !IT_ROUTESETTINGS TYPE /AWS1/CL_AG2ROUTESETTINGS=>TT_ROUTESETTINGSMAP OPTIONAL
    !IV_STAGENAME TYPE /AWS1/AG2__STRING OPTIONAL
    !IT_STAGEVARIABLES TYPE /AWS1/CL_AG2STAGEVARIABLESMA00=>TT_STAGEVARIABLESMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ag2updatestagersp
  RAISING
    /AWS1/CX_AG2BADREQUESTEX
    /AWS1/CX_AG2CONFLICTEXCEPTION
    /AWS1/CX_AG2NOTFOUNDEXCEPTION
    /AWS1/CX_AG2TOOMANYREQUESTSEX
    /AWS1/CX_AG2CLIENTEXC
    /AWS1/CX_AG2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_apiid TYPE /AWS1/AG2__STRING /AWS1/AG2__STRING

The API identifier.

iv_stagename TYPE /AWS1/AG2__STRING /AWS1/AG2__STRING

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Optional arguments:

io_accesslogsettings TYPE REF TO /AWS1/CL_AG2ACCESSLOGSETTINGS /AWS1/CL_AG2ACCESSLOGSETTINGS

Settings for logging access in this stage.

iv_autodeploy TYPE /AWS1/AG2__BOOLEAN /AWS1/AG2__BOOLEAN

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

iv_clientcertificateid TYPE /AWS1/AG2ID /AWS1/AG2ID

The identifier of a client certificate for a Stage.

io_defaultroutesettings TYPE REF TO /AWS1/CL_AG2ROUTESETTINGS /AWS1/CL_AG2ROUTESETTINGS

The default route settings for the stage.

iv_deploymentid TYPE /AWS1/AG2ID /AWS1/AG2ID

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

iv_description TYPE /AWS1/AG2STRWLENGTHBETWEEN0A00 /AWS1/AG2STRWLENGTHBETWEEN0A00

The description for the API stage.

it_routesettings TYPE /AWS1/CL_AG2ROUTESETTINGS=>TT_ROUTESETTINGSMAP TT_ROUTESETTINGSMAP

Route settings for the stage.

it_stagevariables TYPE /AWS1/CL_AG2STAGEVARIABLESMA00=>TT_STAGEVARIABLESMAP TT_STAGEVARIABLESMAP

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

RETURNING

oo_output TYPE REF TO /aws1/cl_ag2updatestagersp /AWS1/CL_AG2UPDATESTAGERSP

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->updatestage(
  io_accesslogsettings = new /aws1/cl_ag2accesslogsettings(
    iv_destinationarn = |string|
    iv_format = |string|
  )
  io_defaultroutesettings = new /aws1/cl_ag2routesettings(
    iv_datatraceenabled = ABAP_TRUE
    iv_detailedmetricsenabled = ABAP_TRUE
    iv_logginglevel = |string|
    iv_throttlingburstlimit = 123
    iv_throttlingratelimit = '0.1'
  )
  it_routesettings = VALUE /aws1/cl_ag2routesettings=>tt_routesettingsmap(
    (
      VALUE /aws1/cl_ag2routesettings=>ts_routesettingsmap_maprow(
        key = |string|
        value = new /aws1/cl_ag2routesettings(
          iv_datatraceenabled = ABAP_TRUE
          iv_detailedmetricsenabled = ABAP_TRUE
          iv_logginglevel = |string|
          iv_throttlingburstlimit = 123
          iv_throttlingratelimit = '0.1'
        )
      )
    )
  )
  it_stagevariables = VALUE /aws1/cl_ag2stagevariablesma00=>tt_stagevariablesmap(
    (
      VALUE /aws1/cl_ag2stagevariablesma00=>ts_stagevariablesmap_maprow(
        key = |string|
        value = new /aws1/cl_ag2stagevariablesma00( |string| )
      )
    )
  )
  iv_apiid = |string|
  iv_autodeploy = ABAP_TRUE
  iv_clientcertificateid = |string|
  iv_deploymentid = |string|
  iv_description = |string|
  iv_stagename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_accesslogsettings = lo_result->get_accesslogsettings( ).
  IF lo_accesslogsettings IS NOT INITIAL.
    lv_arn = lo_accesslogsettings->get_destinationarn( ).
    lv_stringwithlengthbetween = lo_accesslogsettings->get_format( ).
  ENDIF.
  lv___boolean = lo_result->get_apigatewaymanaged( ).
  lv___boolean = lo_result->get_autodeploy( ).
  lv_id = lo_result->get_clientcertificateid( ).
  lv___timestampiso8601 = lo_result->get_createddate( ).
  lo_routesettings = lo_result->get_defaultroutesettings( ).
  IF lo_routesettings IS NOT INITIAL.
    lv___boolean = lo_routesettings->get_datatraceenabled( ).
    lv___boolean = lo_routesettings->get_detailedmetricsenabled( ).
    lv_logginglevel = lo_routesettings->get_logginglevel( ).
    lv___integer = lo_routesettings->get_throttlingburstlimit( ).
    lv___double = lo_routesettings->get_throttlingratelimit( ).
  ENDIF.
  lv_id = lo_result->get_deploymentid( ).
  lv_stringwithlengthbetween_1 = lo_result->get_description( ).
  lv___string = lo_result->get_lastdeploymentstatusmsg( ).
  lv___timestampiso8601 = lo_result->get_lastupdateddate( ).
  LOOP AT lo_result->get_routesettings( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv___boolean = lo_value->get_datatraceenabled( ).
      lv___boolean = lo_value->get_detailedmetricsenabled( ).
      lv_logginglevel = lo_value->get_logginglevel( ).
      lv___integer = lo_value->get_throttlingburstlimit( ).
      lv___double = lo_value->get_throttlingratelimit( ).
    ENDIF.
  ENDLOOP.
  lv_stringwithlengthbetween_2 = lo_result->get_stagename( ).
  LOOP AT lo_result->get_stagevariables( ) into ls_row_1.
    lv_key = ls_row_1-key.
    lo_value_1 = ls_row_1-value.
    IF lo_value_1 IS NOT INITIAL.
      lv_stringwithlengthbetween_3 = lo_value_1->get_value( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_tags( ) into ls_row_2.
    lv_key = ls_row_2-key.
    lo_value_2 = ls_row_2-value.
    IF lo_value_2 IS NOT INITIAL.
      lv_stringwithlengthbetween_4 = lo_value_2->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.