blob: dbaafdec1e2836dd430e121421750f4c5869a383 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
<?php
namespace Guzzle\Service\Resource;
use Guzzle\Common\HasDispatcherInterface;
use Guzzle\Common\ToArrayInterface;
/**
* Iterates over a paginated resource using subsequent requests in order to retrieve the entire matching result set
*/
interface ResourceIteratorInterface extends ToArrayInterface, HasDispatcherInterface, \Iterator, \Countable
{
/**
* Retrieve the NextToken that can be used in other iterators.
*
* @return string Returns a NextToken
*/
public function getNextToken();
/**
* Attempt to limit the total number of resources returned by the iterator.
*
* You may still receive more items than you specify. Set to 0 to specify no limit.
*
* @param int $limit Limit amount
*
* @return ResourceIteratorInterface
*/
public function setLimit($limit);
/**
* Attempt to limit the total number of resources retrieved per request by the iterator.
*
* The iterator may return more than you specify in the page size argument depending on the service and underlying
* command implementation. Set to 0 to specify no page size limitation.
*
* @param int $pageSize Limit amount
*
* @return ResourceIteratorInterface
*/
public function setPageSize($pageSize);
/**
* Get a data option from the iterator
*
* @param string $key Key of the option to retrieve
*
* @return mixed|null Returns NULL if not set or the value if set
*/
public function get($key);
/**
* Set a data option on the iterator
*
* @param string $key Key of the option to set
* @param mixed $value Value to set for the option
*
* @return ResourceIteratorInterface
*/
public function set($key, $value);
}
|
