class Twilio::REST::Preview::DeployedDevices::FleetContext::KeyList
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 KeyList
@param [Version] version Version
that contains the resource @param [String] fleet_sid Specifies the unique string identifier of the Fleet
that the given Key credential belongs to.
@return [KeyList] KeyList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.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]}/Keys" 29 end
Public Instance Methods
Create the KeyInstance
@param [String] friendly_name Provides a human readable descriptive text for
this Key credential, up to 256 characters long.
@param [String] device_sid Provides the unique string identifier of an existing
Device to become authenticated with this Key credential.
@return [KeyInstance] Created KeyInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb 38 def create(friendly_name: :unset, device_sid: :unset) 39 data = Twilio::Values.of({'FriendlyName' => friendly_name, 'DeviceSid' => device_sid, }) 40 41 payload = @version.create('POST', @uri, data: data) 42 43 KeyInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], ) 44 end
When passed a block, yields KeyInstance
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/key.rb 88 def each 89 limits = @version.read_limits 90 91 page = self.page(page_size: limits[:page_size], ) 92 93 @version.stream(page, 94 limit: limits[:limit], 95 page_limit: limits[:page_limit]).each {|x| yield x} 96 end
Retrieve a single page of KeyInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of KeyInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb 125 def get_page(target_url) 126 response = @version.domain.request( 127 'GET', 128 target_url 129 ) 130 KeyPage.new(@version, response, @solution) 131 end
Lists KeyInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [String] device_sid Filters the resulting list of Keys by a unique string
identifier of an authenticated Device.
@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/key.rb 59 def list(device_sid: :unset, limit: nil, page_size: nil) 60 self.stream(device_sid: device_sid, limit: limit, page_size: page_size).entries 61 end
Retrieve a single page of KeyInstance
records from the API. Request
is executed immediately. @param [String] device_sid Filters the resulting list of Keys by a unique string
identifier of an authenticated Device.
@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 KeyInstance
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb 107 def page(device_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) 108 params = Twilio::Values.of({ 109 'DeviceSid' => device_sid, 110 'PageToken' => page_token, 111 'Page' => page_number, 112 'PageSize' => page_size, 113 }) 114 115 response = @version.page('GET', @uri, params: params) 116 117 KeyPage.new(@version, response, @solution) 118 end
Streams KeyInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [String] device_sid Filters the resulting list of Keys by a unique string
identifier of an authenticated Device.
@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/key.rb 76 def stream(device_sid: :unset, limit: nil, page_size: nil) 77 limits = @version.read_limits(limit, page_size) 78 79 page = self.page(device_sid: device_sid, page_size: limits[:page_size], ) 80 81 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 82 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb 135 def to_s 136 '#<Twilio.Preview.DeployedDevices.KeyList>' 137 end