class
Amazonite::ApiGateway::Usage
- Amazonite::ApiGateway::Usage
- Reference
- Object
Overview
Represents the usage data of a usage plan.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/usage.crConstructors
- .new(pull : JSON::PullParser)
- .new(usage_plan_id : String | Nil = nil, start_date : String | Nil = nil, end_date : String | Nil = nil, items : Hash(String, Array(Array(Int64))) | Nil = nil, position : String | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#end_date : String | Nil
The ending date of the usage data.
-
#end_date=(end_date : String | Nil)
The ending date of the usage data.
-
#hash(hasher)
See
Object#hash(hasher) -
#items : Hash(String, Array(Array(Int64))) | Nil
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.
-
#items=(items : Hash(String, Array(Array(Int64))) | Nil)
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.
-
#position : String | Nil
The current pagination position in the paged result set.
-
#position=(position : String | Nil)
The current pagination position in the paged result set.
-
#start_date : String | Nil
The starting date of the usage data.
-
#start_date=(start_date : String | Nil)
The starting date of the usage data.
-
#usage_plan_id : String | Nil
The plan Id associated with this usage data.
-
#usage_plan_id=(usage_plan_id : String | Nil)
The plan Id associated with this usage data.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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].
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].