class Amazonite::ApiGateway::GetUsageRequest

• Amazonite::ApiGateway::GetUsageRequest
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable

Defined in:

api_gateway/get_usage_request.cr

Constructors

• .new(usage_plan_id : String, start_date : String, end_date : String, key_id : String | Nil = nil, position : String | Nil = nil, limit : Int32 | Nil = nil)
• .new(pull : JSON::PullParser)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #end_date : String

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

• #end_date=(end_date : String)

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

• #hash(hasher)

  See Object#hash(hasher)

• #key_id : String | Nil

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

• #key_id=(key_id : String | Nil)

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

• #limit : Int32 | Nil

  The maximum number of returned results per page.

• #limit=(limit : Int32 | Nil)

  The maximum number of returned results per page.

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

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

• #start_date=(start_date : String)

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

• #usage_plan_id : String

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

• #usage_plan_id=(usage_plan_id : String)

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

• #validate! : Nil

Constructor Detail

Instance Method Detail