/AWS1/CL_AG2MODEL¶
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_name TYPE /AWS1/AG2STRWLENGTHBETWEEN1A01 /AWS1/AG2STRWLENGTHBETWEEN1A01¶
The name of the model. Must be alphanumeric.
Optional arguments:¶
iv_contenttype TYPE /AWS1/AG2STRWLENGTHBETWEEN1A05 /AWS1/AG2STRWLENGTHBETWEEN1A05¶
The content-type for the model, for example, "application/json".
iv_description TYPE /AWS1/AG2STRWLENGTHBETWEEN0A00 /AWS1/AG2STRWLENGTHBETWEEN0A00¶
The description of the model.
iv_modelid TYPE /AWS1/AG2ID /AWS1/AG2ID¶
The model identifier.
iv_schema TYPE /AWS1/AG2STRWLENGTHBETWEEN0A01 /AWS1/AG2STRWLENGTHBETWEEN0A01¶
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Queryable Attributes¶
ContentType¶
The content-type for the model, for example, "application/json".
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTENTTYPE() |
Getter for CONTENTTYPE, with configurable default |
ASK_CONTENTTYPE() |
Getter for CONTENTTYPE w/ exceptions if field has no value |
HAS_CONTENTTYPE() |
Determine if CONTENTTYPE has a value |
Description¶
The description of the model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
ModelId¶
The model identifier.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MODELID() |
Getter for MODELID, with configurable default |
ASK_MODELID() |
Getter for MODELID w/ exceptions if field has no value |
HAS_MODELID() |
Determine if MODELID has a value |
Name¶
The name of the model. Must be alphanumeric.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Schema¶
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEMA() |
Getter for SCHEMA, with configurable default |
ASK_SCHEMA() |
Getter for SCHEMA w/ exceptions if field has no value |
HAS_SCHEMA() |
Determine if SCHEMA has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT___LISTOFMODEL¶
TYPES TT___LISTOFMODEL TYPE STANDARD TABLE OF REF TO /AWS1/CL_AG2MODEL WITH DEFAULT KEY
.