Class: SDM::RateLimitMetadata
- Inherits:
-
Object
- Object
- SDM::RateLimitMetadata
- Defined in:
- lib/models/porcelain.rb
Overview
RateLimitMetadata contains information about remaining requests avaialable to the user over some timeframe.
Instance Attribute Summary collapse
-
#bucket ⇒ Object
The bucket this user/token is associated with, which may be shared between multiple users/tokens.
-
#limit ⇒ Object
How many total requests the user/token is authorized to make before being rate limited.
-
#remaining ⇒ Object
How many remaining requests out of the limit are still avaialable.
-
#reset_at ⇒ Object
The time when remaining will be reset to limit.
Instance Method Summary collapse
-
#initialize(bucket: nil, limit: nil, remaining: nil, reset_at: nil) ⇒ RateLimitMetadata
constructor
A new instance of RateLimitMetadata.
- #to_json(options = {}) ⇒ Object
Constructor Details
#initialize(bucket: nil, limit: nil, remaining: nil, reset_at: nil) ⇒ RateLimitMetadata
Returns a new instance of RateLimitMetadata.
13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 |
# File 'lib/models/porcelain.rb', line 13023 def initialize( bucket: nil, limit: nil, remaining: nil, reset_at: nil ) @bucket = bucket == nil ? "" : bucket @limit = limit == nil ? 0 : limit @remaining = remaining == nil ? 0 : remaining @reset_at = reset_at == nil ? nil : reset_at end |
Instance Attribute Details
#bucket ⇒ Object
The bucket this user/token is associated with, which may be shared between multiple users/tokens.
13014 13015 13016 |
# File 'lib/models/porcelain.rb', line 13014 def bucket @bucket end |
#limit ⇒ Object
How many total requests the user/token is authorized to make before being rate limited.
13017 13018 13019 |
# File 'lib/models/porcelain.rb', line 13017 def limit @limit end |
#remaining ⇒ Object
How many remaining requests out of the limit are still avaialable.
13019 13020 13021 |
# File 'lib/models/porcelain.rb', line 13019 def remaining @remaining end |
#reset_at ⇒ Object
The time when remaining will be reset to limit.
13021 13022 13023 |
# File 'lib/models/porcelain.rb', line 13021 def reset_at @reset_at end |
Instance Method Details
#to_json(options = {}) ⇒ Object
13035 13036 13037 13038 13039 13040 13041 |
# File 'lib/models/porcelain.rb', line 13035 def to_json( = {}) hash = {} self.instance_variables.each do |var| hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var end hash.to_json end |