Skip to content

/AWS1/IF_GLU=>REGISTERSCHEMAVERSION()

About RegisterSchemaVersion

Adds a new version to the existing schema. Returns an error if new version of schema does not meet the compatibility requirements of the schema set. This API will not create a new schema set and will return a 404 error if the schema set is not already present in the Schema Registry.

If this is the first schema definition to be registered in the Schema Registry, this API will store the schema version and return immediately. Otherwise, this call has the potential to run longer than other operations due to compatibility modes. You can call the GetSchemaVersion API with the SchemaVersionId to check compatibility modes.

If the same schema definition is already stored in Schema Registry as a version, the schema ID of the existing schema is returned to the caller.

Method Signature

METHODS /AWS1/IF_GLU~REGISTERSCHEMAVERSION
  IMPORTING
    !IO_SCHEMAID TYPE REF TO /AWS1/CL_GLUSCHEMAID OPTIONAL
    !IV_SCHEMADEFINITION TYPE /AWS1/GLUSCHEMADEFNSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gluregschemavrsrsp
  RAISING
    /AWS1/CX_GLUACCESSDENIEDEX
    /AWS1/CX_GLUCONCURRENTMODEX
    /AWS1/CX_GLUENTITYNOTFOUNDEX
    /AWS1/CX_GLUINTERNALSERVICEEX
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLURESRCNUMLMTEXCDEX
    /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. Either SchemaArn or SchemaName and RegistryName has to be provided.

  • SchemaId$SchemaName: The name of the schema. Either SchemaArn or SchemaName and RegistryName has to be provided.

iv_schemadefinition TYPE /AWS1/GLUSCHEMADEFNSTRING /AWS1/GLUSCHEMADEFNSTRING

The schema definition using the DataFormat setting for the SchemaName.

RETURNING

oo_output TYPE REF TO /aws1/cl_gluregschemavrsrsp /AWS1/CL_GLUREGSCHEMAVRSRSP

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->registerschemaversion(
  io_schemaid = new /aws1/cl_gluschemaid(
    iv_registryname = |string|
    iv_schemaarn = |string|
    iv_schemaname = |string|
  )
  iv_schemadefinition = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_schemaversionidstring = lo_result->get_schemaversionid( ).
  lv_versionlongnumber = lo_result->get_versionnumber( ).
  lv_schemaversionstatus = lo_result->get_status( ).
ENDIF.