Interface ResourceIteratorInterface

Iterates over a paginated resource using subsequent requests in order to retrieve the entire matching result set

Guzzle\Service\Resource\ResourceIteratorInterface implements Guzzle\Common\ToArrayInterface, Guzzle\Common\HasDispatcherInterface, Iterator, Countable

Direct known implementers

Guzzle\Service\Resource\ResourceIterator

Indirect known implementers

Guzzle\Tests\Service\Mock\Model\MockCommandIterator

Namespace: Guzzle\Service\Resource
Located at src/Guzzle/Service/Resource/ResourceIteratorInterface.php

Methods summary
`public string`	# `getNextToken( )` Retrieve the NextToken that can be used in other iterators. Retrieve the NextToken that can be used in other iterators. Returns string Returns a NextToken
`public Guzzle\Service\Resource\ResourceIteratorInterface`	# `setLimit( integer $limit )` Attempt to limit the total number of resources returned by the iterator. 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. Parameters `$limit` Limit amount Returns `Guzzle\Service\Resource\ResourceIteratorInterface`
`public Guzzle\Service\Resource\ResourceIteratorInterface`	# `setPageSize( integer $pageSize )` Attempt to limit the total number of resources retrieved per request by the iterator. 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. Parameters `$pageSize` Limit amount Returns `Guzzle\Service\Resource\ResourceIteratorInterface`
`public mixed\|null`	# `get( string $key )` Get a data option from the iterator Get a data option from the iterator Parameters `$key` Key of the option to retrieve Returns mixed\|null Returns NULL if not set or the value if set
`public Guzzle\Service\Resource\ResourceIteratorInterface`	# `set( string $key, mixed $value )` Set a data option on the iterator Set a data option on the iterator Parameters `$key` Key of the option to set `$value` Value to set for the option Returns `Guzzle\Service\Resource\ResourceIteratorInterface`

Methods inherited from Guzzle\Common\ToArrayInterface
`toArray()`

Methods inherited from Guzzle\Common\HasDispatcherInterface
`addSubscriber(), dispatch(), getAllEvents(), getEventDispatcher(), setEventDispatcher()`

Methods inherited from Iterator
`current(), key(), next(), rewind(), valid()`

Methods inherited from Countable
`count()`

Namespaces

Classes

Interfaces

Interface ResourceIteratorInterface

Direct known implementers

Indirect known implementers

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns