1MetaCPAN::Client::ResulUtsSeert(C3o)ntributed Perl DocumMeenttaaCtPiAoNn::Client::ResultSet(3)
2
3
4

NAME

6       MetaCPAN::Client::ResultSet - A Result Set
7

VERSION

9       version 2.030000
10

DESCRIPTION

12       Object representing a result from Elastic Search. This is used for the
13       complex (as in non-simple) queries to MetaCPAN. It provides easy access
14       to the scroller and aggregations.
15

ATTRIBUTES

17   scroller
18       An MetaCPAN::Client::Scroll object.
19
20   items
21       An arrayref of items to manually scroll over, instead of a scroller
22       object.
23
24   type
25       The entity of the result set. Available types:
26
27       •   author
28
29       •   distribution
30
31       •   module
32
33       •   release
34
35       •   favorite
36
37       •   file
38
39   aggregations
40       The aggregations available in the Elastic Search response.
41

METHODS

43   next
44       Iterator call to fetch the next result set object.
45
46   total
47       Iterator call to fetch the total amount of objects available in result
48       set.
49
50   has_scroller
51       Predicate for ES scroller presence.
52
53   BUILDARGS
54       Double checks construction of objects. You should never run this
55       yourself.
56
57   BUILD
58       Validates the object. You should never run this yourself.
59

AUTHORS

61       •   Sawyer X <xsawyerx@cpan.org>
62
63       •   Mickey Nasriachi <mickey@cpan.org>
64

66       This software is copyright (c) 2016 by Sawyer X.
67
68       This is free software; you can redistribute it and/or modify it under
69       the same terms as the Perl 5 programming language system itself.
70
71
72
73perl v5.38.0                      2023-07-20    MetaCPAN::Client::ResultSet(3)
Impressum