class Twilio::REST::Verify::V2::ServiceContext::RateLimitContext::BucketList
Public Class Methods
Initialize the BucketList
@param [Version] version Version
that contains the resource @param [String] service_sid The SID of the
{Service}[https://www.twilio.com/docs/verify/api/service] the resource is associated with.
@param [String] rate_limit_sid The Twilio-provided string that uniquely
identifies the Rate Limit resource.
@return [BucketList] BucketList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 25 def initialize(version, service_sid: nil, rate_limit_sid: nil) 26 super(version) 27 28 # Path Solution 29 @solution = {service_sid: service_sid, rate_limit_sid: rate_limit_sid} 30 @uri = "/Services/#{@solution[:service_sid]}/RateLimits/#{@solution[:rate_limit_sid]}/Buckets" 31 end
Public Instance Methods
Create the BucketInstance
@param [String] max Maximum number of requests permitted in during the interval. @param [String] interval Number of seconds that the rate limit will be enforced
over.
@return [BucketInstance] Created BucketInstance
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 39 def create(max: nil, interval: nil) 40 data = Twilio::Values.of({'Max' => max, 'Interval' => interval, }) 41 42 payload = @version.create('POST', @uri, data: data) 43 44 BucketInstance.new( 45 @version, 46 payload, 47 service_sid: @solution[:service_sid], 48 rate_limit_sid: @solution[:rate_limit_sid], 49 ) 50 end
When passed a block, yields BucketInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 90 def each 91 limits = @version.read_limits 92 93 page = self.page(page_size: limits[:page_size], ) 94 95 @version.stream(page, 96 limit: limits[:limit], 97 page_limit: limits[:page_limit]).each {|x| yield x} 98 end
Retrieve a single page of BucketInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of BucketInstance
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 124 def get_page(target_url) 125 response = @version.domain.request( 126 'GET', 127 target_url 128 ) 129 BucketPage.new(@version, response, @solution) 130 end
Lists BucketInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 63 def list(limit: nil, page_size: nil) 64 self.stream(limit: limit, page_size: page_size).entries 65 end
Retrieve a single page of BucketInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of BucketInstance
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 107 def page(page_token: :unset, page_number: :unset, page_size: :unset) 108 params = Twilio::Values.of({ 109 'PageToken' => page_token, 110 'Page' => page_number, 111 'PageSize' => page_size, 112 }) 113 114 response = @version.page('GET', @uri, params: params) 115 116 BucketPage.new(@version, response, @solution) 117 end
Streams BucketInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 78 def stream(limit: nil, page_size: nil) 79 limits = @version.read_limits(limit, page_size) 80 81 page = self.page(page_size: limits[:page_size], ) 82 83 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 84 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb 134 def to_s 135 '#<Twilio.Verify.V2.BucketList>' 136 end