class Amazonite::ApiGateway::GetUsageRequest

Overview

The GET request to get the usage data of a usage plan in a specified time interval.

Included Modules

Defined in:

api_gateway/get_usage_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(usage_plan_id : String, start_date : String, end_date : String, key_id : String | Nil = nil, position : String | Nil = nil, limit : Int32 | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[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 #

The ending date (e.g., 2016-12-31) of the usage data.


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

The ending date (e.g., 2016-12-31) of the usage data.


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

See Object#hash(hasher)


def key_id : String | Nil #

The Id of the API key associated with the resultant usage data.


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

The Id of the API key associated with the resultant usage data.


[View source]
def limit : Int32 | Nil #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.


[View source]
def limit=(limit : Int32 | Nil) #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.


[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 #

The starting date (e.g., 2016-01-01) of the usage data.


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

The starting date (e.g., 2016-01-01) of the usage data.


[View source]
def usage_plan_id : String #

The Id of the usage plan associated with the usage data.


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

The Id of the usage plan associated with the usage data.


[View source]
def validate! : Nil #

[View source]