class Twilio::REST::Preview::DeployedDevices::FleetList
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
Public Class Methods
Initialize the FleetList
@param [Version] version Version
that contains the resource @return [FleetList] FleetList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 20 def initialize(version) 21 super(version) 22 23 # Path Solution 24 @solution = {} 25 @uri = "/Fleets" 26 end
Public Instance Methods
Create the FleetInstance
@param [String] friendly_name Provides a human readable descriptive text for
this Fleet, up to 256 characters long.
@return [FleetInstance] Created FleetInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 33 def create(friendly_name: :unset) 34 data = Twilio::Values.of({'FriendlyName' => friendly_name, }) 35 36 payload = @version.create('POST', @uri, data: data) 37 38 FleetInstance.new(@version, payload, ) 39 end
When passed a block, yields FleetInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 79 def each 80 limits = @version.read_limits 81 82 page = self.page(page_size: limits[:page_size], ) 83 84 @version.stream(page, 85 limit: limits[:limit], 86 page_limit: limits[:page_limit]).each {|x| yield x} 87 end
Retrieve a single page of FleetInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of FleetInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 113 def get_page(target_url) 114 response = @version.domain.request( 115 'GET', 116 target_url 117 ) 118 FleetPage.new(@version, response, @solution) 119 end
Lists FleetInstance
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/preview/deployed_devices/fleet.rb 52 def list(limit: nil, page_size: nil) 53 self.stream(limit: limit, page_size: page_size).entries 54 end
Retrieve a single page of FleetInstance
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 FleetInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 96 def page(page_token: :unset, page_number: :unset, page_size: :unset) 97 params = Twilio::Values.of({ 98 'PageToken' => page_token, 99 'Page' => page_number, 100 'PageSize' => page_size, 101 }) 102 103 response = @version.page('GET', @uri, params: params) 104 105 FleetPage.new(@version, response, @solution) 106 end
Streams FleetInstance
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/preview/deployed_devices/fleet.rb 67 def stream(limit: nil, page_size: nil) 68 limits = @version.read_limits(limit, page_size) 69 70 page = self.page(page_size: limits[:page_size], ) 71 72 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 73 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb 123 def to_s 124 '#<Twilio.Preview.DeployedDevices.FleetList>' 125 end