1 class ArvadosResourceList
2 include ArvadosApiClientHelper
5 attr_reader :resource_class
7 def initialize resource_class=nil
8 @resource_class = resource_class
9 @fetch_multiple_pages = true
10 @arvados_api_token = Thread.current[:arvados_api_token]
11 @reader_tokens = Thread.current[:reader_tokens]
19 def distinct(bool=true)
24 def include_trash(option=nil)
25 @include_trash = option
29 def recursive(option=nil)
34 def limit(max_results)
35 if not max_results.nil? and not max_results.is_a? Integer
36 raise ArgumentError("argument to limit() must be an Integer or nil")
47 def order(orderby_spec)
48 @orderby_spec = orderby_spec
52 def select(columns=nil)
53 # If no column arguments were given, invoke Enumerable#select.
71 @cond.keys.each do |uuid_key|
72 if @cond[uuid_key] and (@cond[uuid_key].is_a? Array or
73 @cond[uuid_key].is_a? ArvadosBase)
74 # Coerce cond[uuid_key] to an array of uuid strings. This
75 # allows caller the convenience of passing an array of real
76 # objects and uuids in cond[uuid_key].
77 if !@cond[uuid_key].is_a? Array
78 @cond[uuid_key] = [@cond[uuid_key]]
80 @cond[uuid_key] = @cond[uuid_key].collect do |item|
81 if item.is_a? ArvadosBase
89 @cond.keys.select { |x| x.match /_kind$/ }.each do |kind_key|
90 if @cond[kind_key].is_a? Class
91 @cond = @cond.merge({ kind_key => 'arvados#' + arvados_api_client.class_kind(@cond[kind_key]) })
97 # with_count sets the 'count' parameter to 'exact' or 'none' -- see
98 # https://doc.arvados.org/api/methods.html#index
99 def with_count(count_param='exact')
104 def fetch_multiple_pages(f)
105 @fetch_multiple_pages = f
112 self.each_page do |r|
121 @items_available = r.items_available if r.respond_to? :items_available
122 @result_limit = r.limit if r.respond_to? :limit
123 @result_offset = r.offset if r.respond_to? :offset
135 self.each_page do |items|
153 results.send('[]', *x)
165 Hash[self.collect { |x| [x.uuid, x] }]
187 # Obsolete method retained during api transition.
188 def links_for item_or_uuid, link_class=false
198 api_params[:count] = @count if @count
199 api_params[:where] = @cond if @cond
200 api_params[:eager] = '1' if @eager
201 api_params[:select] = @select if @select
202 api_params[:order] = @orderby_spec if @orderby_spec
203 api_params[:filters] = @filters if @filters
204 api_params[:distinct] = @distinct if @distinct
205 api_params[:include_trash] = @include_trash if @include_trash
206 if @fetch_multiple_pages
207 # Default limit to (effectively) api server's MAX_LIMIT
208 api_params[:limit] = 2**(0.size*8 - 1) - 1
212 offset = @offset || 0
217 api_params[:offset] = offset
218 api_params[:limit] = (@limit - item_count) if @limit
220 res = arvados_api_client.api(@resource_class, '', api_params,
221 arvados_api_token: @arvados_api_token,
222 reader_tokens: @reader_tokens)
223 items = arvados_api_client.unpack_api_response res
225 @items_available = items.items_available if items.respond_to?(:items_available)
226 @result_limit = items.limit if (@fetch_multiple_pages == false) and items.respond_to?(:limit)
227 @result_offset = items.offset if (@fetch_multiple_pages == false) and items.respond_to?(:offset)
229 break if items.nil? or not items.any?
231 item_count += items.size
232 if items.respond_to?(:offset)
233 offset = items.offset + items.size
240 break if @limit and item_count >= @limit
241 break if items.respond_to? :items_available and offset >= items.items_available
242 end while @fetch_multiple_pages