class Twilio::REST::Sync::V1::ServiceContext::SyncMapList
Public Class Methods
Initialize the SyncMapList
@param [Version] version Version
that contains the resource @param [String] service_sid The SID of the {Sync
Service}[https://www.twilio.com/docs/sync/api/service] the resource is associated with.
@return [SyncMapList] SyncMapList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 22 def initialize(version, service_sid: nil) 23 super(version) 24 25 # Path Solution 26 @solution = {service_sid: service_sid} 27 @uri = "/Services/#{@solution[:service_sid]}/Maps" 28 end
Public Instance Methods
Create the SyncMapInstance
@param [String] unique_name An application-defined string that uniquely
identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource.
@param [String] ttl An alias for `collection_ttl`. If both parameters are
provided, this value is ignored.
@param [String] collection_ttl How long, {in
seconds}[https://www.twilio.com/docs/sync/limits#sync-payload-limits], before the Sync Map expires (time-to-live) and is deleted.
@return [SyncMapInstance] Created SyncMapInstance
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 41 def create(unique_name: :unset, ttl: :unset, collection_ttl: :unset) 42 data = Twilio::Values.of({ 43 'UniqueName' => unique_name, 44 'Ttl' => ttl, 45 'CollectionTtl' => collection_ttl, 46 }) 47 48 payload = @version.create('POST', @uri, data: data) 49 50 SyncMapInstance.new(@version, payload, service_sid: @solution[:service_sid], ) 51 end
When passed a block, yields SyncMapInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 91 def each 92 limits = @version.read_limits 93 94 page = self.page(page_size: limits[:page_size], ) 95 96 @version.stream(page, 97 limit: limits[:limit], 98 page_limit: limits[:page_limit]).each {|x| yield x} 99 end
Retrieve a single page of SyncMapInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of SyncMapInstance
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 125 def get_page(target_url) 126 response = @version.domain.request( 127 'GET', 128 target_url 129 ) 130 SyncMapPage.new(@version, response, @solution) 131 end
Lists SyncMapInstance
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/sync/v1/service/sync_map.rb 64 def list(limit: nil, page_size: nil) 65 self.stream(limit: limit, page_size: page_size).entries 66 end
Retrieve a single page of SyncMapInstance
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 SyncMapInstance
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 108 def page(page_token: :unset, page_number: :unset, page_size: :unset) 109 params = Twilio::Values.of({ 110 'PageToken' => page_token, 111 'Page' => page_number, 112 'PageSize' => page_size, 113 }) 114 115 response = @version.page('GET', @uri, params: params) 116 117 SyncMapPage.new(@version, response, @solution) 118 end
Streams SyncMapInstance
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/sync/v1/service/sync_map.rb 79 def stream(limit: nil, page_size: nil) 80 limits = @version.read_limits(limit, page_size) 81 82 page = self.page(page_size: limits[:page_size], ) 83 84 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 85 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/sync/v1/service/sync_map.rb 135 def to_s 136 '#<Twilio.Sync.V1.SyncMapList>' 137 end