/AWS1/CL_AGWUSAGE¶
Represents the usage data of a usage plan.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_usageplanid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING¶
The plan Id associated with this usage data.
iv_startdate TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING¶
The starting date of the usage data.
iv_enddate TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING¶
The ending date of the usage data.
it_items TYPE /AWS1/CL_AGWLISTOFLONG_W=>TT_MAPOFKEYUSAGES TT_MAPOFKEYUSAGES¶
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where{api_key}stands for an API key value and the daily log entry is of the format[used quota, remaining quota].
iv_position TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING¶
The current pagination position in the paged result set.
Queryable Attributes¶
usagePlanId¶
The plan Id associated with this usage data.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USAGEPLANID() |
Getter for USAGEPLANID, with configurable default |
ASK_USAGEPLANID() |
Getter for USAGEPLANID w/ exceptions if field has no value |
HAS_USAGEPLANID() |
Determine if USAGEPLANID has a value |
startDate¶
The starting date of the usage data.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTDATE() |
Getter for STARTDATE, with configurable default |
ASK_STARTDATE() |
Getter for STARTDATE w/ exceptions if field has no value |
HAS_STARTDATE() |
Determine if STARTDATE has a value |
endDate¶
The ending date of the usage data.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDDATE() |
Getter for ENDDATE, with configurable default |
ASK_ENDDATE() |
Getter for ENDDATE w/ exceptions if field has no value |
HAS_ENDDATE() |
Determine if ENDDATE has a value |
items¶
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,
{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where{api_key}stands for an API key value and the daily log entry is of the format[used quota, remaining quota].
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ITEMS() |
Getter for ITEMS, with configurable default |
ASK_ITEMS() |
Getter for ITEMS w/ exceptions if field has no value |
HAS_ITEMS() |
Determine if ITEMS has a value |
position¶
The current pagination position in the paged result set.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_POSITION() |
Getter for POSITION, with configurable default |
ASK_POSITION() |
Getter for POSITION w/ exceptions if field has no value |
HAS_POSITION() |
Determine if POSITION has a value |