.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MetaCPAN::Client::Scroll 3pm"
.TH MetaCPAN::Client::Scroll 3pm 2024-03-24 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
MetaCPAN::Client::Scroll \- A MetaCPAN::Client scroller
.SH VERSION
.IX Header "VERSION"
version 2.031001
.SH METHODS
.IX Header "METHODS"
.SS next
.IX Subsection "next"
get next matched document.
.SS BUILDARGS
.IX Subsection "BUILDARGS"
.SS DEMOLISH
.IX Subsection "DEMOLISH"
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS aggregations
.IX Subsection "aggregations"
The returned aggregations structure from agg
requests.
.SS base_url
.IX Subsection "base_url"
The base URL for sending server requests.
.SS body
.IX Subsection "body"
The request body.
.SS size
.IX Subsection "size"
The number of docs to pull from each shard per request.
.SS time
.IX Subsection "time"
The lifetime of the scroller on the server.
.SS total
.IX Subsection "total"
The total number of matches.
.SS type
.IX Subsection "type"
The Elasticsearch type to query.
.SS ua
.IX Subsection "ua"
The user agent object for running requests.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Sawyer X <xsawyerx@cpan.org>
.IP \(bu 4
Mickey Nasriachi <mickey@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Sawyer X.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.