/AWS1/CL_AG2CREINTEGRATIONRS01¶
CreateIntegrationResponseResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_CONTENTHANDLINGSTRATEGY TYPE /AWS1/AG2CONTENTHANDLINGSTRAG /AWS1/AG2CONTENTHANDLINGSTRAG¶
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
IV_INTEGRATIONRESPONSEID TYPE /AWS1/AG2ID /AWS1/AG2ID¶
The integration response ID.
IV_INTEGRATIONRESPONSEKEY TYPE /AWS1/AG2SELECTIONKEY /AWS1/AG2SELECTIONKEY¶
The integration response key.
IT_RESPONSEPARAMETERS TYPE /AWS1/CL_AG2INTEGRATIONPARMS_W=>TT_INTEGRATIONPARAMETERS TT_INTEGRATIONPARAMETERS¶
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
IT_RESPONSETEMPLATES TYPE /AWS1/CL_AG2TEMPLATEMAP_W=>TT_TEMPLATEMAP TT_TEMPLATEMAP¶
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
IV_TEMPLATESELECTIONXPRSN TYPE /AWS1/AG2SELECTIONEXPRESSION /AWS1/AG2SELECTIONEXPRESSION¶
The template selection expressions for the integration response.
Queryable Attributes¶
ContentHandlingStrategy¶
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONTENTHANDLINGSTRATEGY() |
Getter for CONTENTHANDLINGSTRATEGY, with configurable defaul |
ASK_CONTENTHANDLINGSTRATEGY() |
Getter for CONTENTHANDLINGSTRATEGY w/ exceptions if field ha |
HAS_CONTENTHANDLINGSTRATEGY() |
Determine if CONTENTHANDLINGSTRATEGY has a value |
IntegrationResponseId¶
The integration response ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INTEGRATIONRESPONSEID() |
Getter for INTEGRATIONRESPONSEID, with configurable default |
ASK_INTEGRATIONRESPONSEID() |
Getter for INTEGRATIONRESPONSEID w/ exceptions if field has |
HAS_INTEGRATIONRESPONSEID() |
Determine if INTEGRATIONRESPONSEID has a value |
IntegrationResponseKey¶
The integration response key.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INTEGRATIONRESPONSEKEY() |
Getter for INTEGRATIONRESPONSEKEY, with configurable default |
ASK_INTEGRATIONRESPONSEKEY() |
Getter for INTEGRATIONRESPONSEKEY w/ exceptions if field has |
HAS_INTEGRATIONRESPONSEKEY() |
Determine if INTEGRATIONRESPONSEKEY has a value |
ResponseParameters¶
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESPONSEPARAMETERS() |
Getter for RESPONSEPARAMETERS, with configurable default |
ASK_RESPONSEPARAMETERS() |
Getter for RESPONSEPARAMETERS w/ exceptions if field has no |
HAS_RESPONSEPARAMETERS() |
Determine if RESPONSEPARAMETERS has a value |
ResponseTemplates¶
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESPONSETEMPLATES() |
Getter for RESPONSETEMPLATES, with configurable default |
ASK_RESPONSETEMPLATES() |
Getter for RESPONSETEMPLATES w/ exceptions if field has no v |
HAS_RESPONSETEMPLATES() |
Determine if RESPONSETEMPLATES has a value |
TemplateSelectionExpression¶
The template selection expressions for the integration response.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TEMPLATESELECTIONXPRSN() |
Getter for TEMPLATESELECTIONEXPRESSION, with configurable de |
ASK_TEMPLATESELECTIONXPRSN() |
Getter for TEMPLATESELECTIONEXPRESSION w/ exceptions if fiel |
HAS_TEMPLATESELECTIONXPRSN() |
Determine if TEMPLATESELECTIONEXPRESSION has a value |