retort v1.3.0 Retort.Client.Stream
Streams the resources from all the pages available on an Retort.Client.index/3
.
Summary
Functions
A new stream of pid
’s Retort.Client.index/3
starting with the given params
and timeout
for
each request
Types
t()
t() :: %Retort.Client.Stream{pagination: Alembic.Pagination.t, params: map, pid: pid, timeout: timeout}
The internal state of stream produced by new/3
.
params
- the params passed toRetort.Client.index/3
. After the initial call,"page[number]"
and"page[size]"
will be overridden with theAlembic.Pagination.t
next
Alembic.Pagination.Page.t
number
andsize
.pid
- thepid
of anRetort.Client
timeout
- the timeout for eachRetort.Client.index/3
call
Functions
A new stream of pid
’s Retort.Client.index/3
starting with the given params
and timeout
for
each request.