/AWS1/CL_DEXAPIGATEWAYAPIASSET¶
The API Gateway API that is the asset.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_apidescription TYPE /AWS1/DEXAPIDESCRIPTION /AWS1/DEXAPIDESCRIPTION¶
The API description of the API asset.
iv_apiendpoint TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The API endpoint of the API asset.
iv_apiid TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The unique identifier of the API asset.
iv_apikey TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The API key of the API asset.
iv_apiname TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The API name of the API asset.
iv_apispecdownloadurl TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The download URL of the API specification of the API asset.
iv_apispecdownloadurlexpir00 TYPE /AWS1/DEXTIMESTAMP /AWS1/DEXTIMESTAMP¶
The date and time that the upload URL expires, in ISO 8601 format.
iv_protocoltype TYPE /AWS1/DEXPROTOCOLTYPE /AWS1/DEXPROTOCOLTYPE¶
The protocol type of the API asset.
iv_stage TYPE /AWS1/DEX__STRING /AWS1/DEX__STRING¶
The stage of the API asset.
Queryable Attributes¶
ApiDescription¶
The API description of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIDESCRIPTION() |
Getter for APIDESCRIPTION, with configurable default |
ASK_APIDESCRIPTION() |
Getter for APIDESCRIPTION w/ exceptions if field has no valu |
HAS_APIDESCRIPTION() |
Determine if APIDESCRIPTION has a value |
ApiEndpoint¶
The API endpoint of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIENDPOINT() |
Getter for APIENDPOINT, with configurable default |
ASK_APIENDPOINT() |
Getter for APIENDPOINT w/ exceptions if field has no value |
HAS_APIENDPOINT() |
Determine if APIENDPOINT has a value |
ApiId¶
The unique identifier of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIID() |
Getter for APIID, with configurable default |
ASK_APIID() |
Getter for APIID w/ exceptions if field has no value |
HAS_APIID() |
Determine if APIID has a value |
ApiKey¶
The API key of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIKEY() |
Getter for APIKEY, with configurable default |
ASK_APIKEY() |
Getter for APIKEY w/ exceptions if field has no value |
HAS_APIKEY() |
Determine if APIKEY has a value |
ApiName¶
The API name of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APINAME() |
Getter for APINAME, with configurable default |
ASK_APINAME() |
Getter for APINAME w/ exceptions if field has no value |
HAS_APINAME() |
Determine if APINAME has a value |
ApiSpecificationDownloadUrl¶
The download URL of the API specification of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APISPECDOWNLOADURL() |
Getter for APISPECIFICATIONDOWNLOADURL, with configurable de |
ASK_APISPECDOWNLOADURL() |
Getter for APISPECIFICATIONDOWNLOADURL w/ exceptions if fiel |
HAS_APISPECDOWNLOADURL() |
Determine if APISPECIFICATIONDOWNLOADURL has a value |
ApiSpecificationDownloadUrlExpiresAt¶
The date and time that the upload URL expires, in ISO 8601 format.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APISPECDOWNLOADURLEXPI00() |
Getter for APISPECDOWNLOADURLEXPIRESAT, with configurable de |
ASK_APISPECDOWNLOADURLEXPI00() |
Getter for APISPECDOWNLOADURLEXPIRESAT w/ exceptions if fiel |
HAS_APISPECDOWNLOADURLEXPI00() |
Determine if APISPECDOWNLOADURLEXPIRESAT has a value |
ProtocolType¶
The protocol type of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROTOCOLTYPE() |
Getter for PROTOCOLTYPE, with configurable default |
ASK_PROTOCOLTYPE() |
Getter for PROTOCOLTYPE w/ exceptions if field has no value |
HAS_PROTOCOLTYPE() |
Determine if PROTOCOLTYPE has a value |
Stage¶
The stage of the API asset.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STAGE() |
Getter for STAGE, with configurable default |
ASK_STAGE() |
Getter for STAGE w/ exceptions if field has no value |
HAS_STAGE() |
Determine if STAGE has a value |