class Amazonite::ApiGateway::Usage

Overview

Represents the usage data of a usage plan.

Included Modules

Defined in:

api_gateway/usage.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def end_date : String | Nil #

The ending date of the usage data.


[View source]
def end_date=(end_date : String | Nil) #

The ending date of the usage data.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def 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. 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].


[View source]
def 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. 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].


[View source]
def position : String | Nil #

The current pagination position in the paged result set.


[View source]
def position=(position : String | Nil) #

The current pagination position in the paged result set.


[View source]
def start_date : String | Nil #

The starting date of the usage data.


[View source]
def start_date=(start_date : String | Nil) #

The starting date of the usage data.


[View source]
def usage_plan_id : String | Nil #

The plan Id associated with this usage data.


[View source]
def usage_plan_id=(usage_plan_id : String | Nil) #

The plan Id associated with this usage data.


[View source]
def validate! : Nil #

[View source]