UPDATESCHEMA()`¶

About UpdateSchema¶

Updates the description, compatibility setting, or version checkpoint for a schema set.

For updating the compatibility setting, the call will not validate compatibility for the entire set of schema versions with the new compatibility setting. If the value for Compatibility is provided, the VersionNumber (a checkpoint) is also required. The API will validate the checkpoint version number for consistency.

If the value for the VersionNumber (checkpoint) is provided, Compatibility is optional and this can be used to set/reset a checkpoint for the schema.

This update will happen only if the schema is in the AVAILABLE state.

Method Signature¶

METHODS /AWS1/IF_GLU~UPDATESCHEMA
  IMPORTING
    !IO_SCHEMAID TYPE REF TO /AWS1/CL_GLUSCHEMAID OPTIONAL
    !IO_SCHEMAVERSIONNUMBER TYPE REF TO /AWS1/CL_GLUSCHEMAVRSNUMBER OPTIONAL
    !IV_COMPATIBILITY TYPE /AWS1/GLUCOMPATIBILITY OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/GLUDESCRIPTIONSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gluupdateschemarsp
  RAISING
    /AWS1/CX_GLUACCESSDENIEDEX
    /AWS1/CX_GLUCONCURRENTMODEX
    /AWS1/CX_GLUENTITYNOTFOUNDEX
    /AWS1/CX_GLUINTERNALSERVICEEX
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLUCLIENTEXC
    /AWS1/CX_GLUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_schemaid` `TYPE REF TO /AWS1/CL_GLUSCHEMAID` `/AWS1/CL_GLUSCHEMAID`¶

This is a wrapper structure to contain schema identity fields. The structure contains:

SchemaId$SchemaArn: The Amazon Resource Name (ARN) of the schema. One of SchemaArn or SchemaName has to be provided.

SchemaId$SchemaName: The name of the schema. One of SchemaArn or SchemaName has to be provided.

Optional arguments:¶

`io_schemaversionnumber` `TYPE REF TO /AWS1/CL_GLUSCHEMAVRSNUMBER` `/AWS1/CL_GLUSCHEMAVRSNUMBER`¶

Version number required for check pointing. One of VersionNumber or Compatibility has to be provided.

`iv_compatibility` `TYPE /AWS1/GLUCOMPATIBILITY` `/AWS1/GLUCOMPATIBILITY`¶

The new compatibility setting for the schema.

`iv_description` `TYPE /AWS1/GLUDESCRIPTIONSTRING` `/AWS1/GLUDESCRIPTIONSTRING`¶

The new description for the schema.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gluupdateschemarsp` `/AWS1/CL_GLUUPDATESCHEMARSP`¶

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->updateschema(
  io_schemaid = new /aws1/cl_gluschemaid(
    iv_registryname = |string|
    iv_schemaarn = |string|
    iv_schemaname = |string|
  )
  io_schemaversionnumber = new /aws1/cl_gluschemavrsnumber(
    iv_latestversion = ABAP_TRUE
    iv_versionnumber = 123
  )
  iv_compatibility = |string|
  iv_description = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_glueresourcearn = lo_result->get_schemaarn( ).
  lv_schemaregistrynamestrin = lo_result->get_schemaname( ).
  lv_schemaregistrynamestrin = lo_result->get_registryname( ).
ENDIF.

/AWS1/IF_GLU=>UPDATESCHEMA()¶