class Twilio::REST::Preview::DeployedDevices::FleetContext::DeploymentList
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 DeploymentList
@param [Version] version Version
that contains the resource @param [String] fleet_sid Specifies the unique string identifier of the Fleet
that the given Deployment belongs to.
@return [DeploymentList] DeploymentList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb 23 def initialize(version, fleet_sid: nil) 24 super(version) 25 26 # Path Solution 27 @solution = {fleet_sid: fleet_sid} 28 @uri = "/Fleets/#{@solution[:fleet_sid]}/Deployments" 29 end
Public Instance Methods
Create the DeploymentInstance
@param [String] friendly_name Provides a human readable descriptive text for
this Deployment, up to 256 characters long.
@param [String] sync_service_sid Provides the unique string identifier of the
Twilio Sync service instance that will be linked to and accessible by this Deployment.
@return [DeploymentInstance] Created DeploymentInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb 39 def create(friendly_name: :unset, sync_service_sid: :unset) 40 data = Twilio::Values.of({'FriendlyName' => friendly_name, 'SyncServiceSid' => sync_service_sid, }) 41 42 payload = @version.create('POST', @uri, data: data) 43 44 DeploymentInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], ) 45 end
When passed a block, yields DeploymentInstance
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/deployment.rb 85 def each 86 limits = @version.read_limits 87 88 page = self.page(page_size: limits[:page_size], ) 89 90 @version.stream(page, 91 limit: limits[:limit], 92 page_limit: limits[:page_limit]).each {|x| yield x} 93 end
Retrieve a single page of DeploymentInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of DeploymentInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb 119 def get_page(target_url) 120 response = @version.domain.request( 121 'GET', 122 target_url 123 ) 124 DeploymentPage.new(@version, response, @solution) 125 end
Lists DeploymentInstance
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/deployment.rb 58 def list(limit: nil, page_size: nil) 59 self.stream(limit: limit, page_size: page_size).entries 60 end
Retrieve a single page of DeploymentInstance
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 DeploymentInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb 102 def page(page_token: :unset, page_number: :unset, page_size: :unset) 103 params = Twilio::Values.of({ 104 'PageToken' => page_token, 105 'Page' => page_number, 106 'PageSize' => page_size, 107 }) 108 109 response = @version.page('GET', @uri, params: params) 110 111 DeploymentPage.new(@version, response, @solution) 112 end
Streams DeploymentInstance
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/deployment.rb 73 def stream(limit: nil, page_size: nil) 74 limits = @version.read_limits(limit, page_size) 75 76 page = self.page(page_size: limits[:page_size], ) 77 78 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 79 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb 129 def to_s 130 '#<Twilio.Preview.DeployedDevices.DeploymentList>' 131 end