Some or all of the information on this page might not apply to Trusted Cloud by S3NS.

Class Iterator (2.3.0)

Iterator(
    query,
    client,
    limit=None,
    offset=None,
    start_cursor=None,
    end_cursor=None,
    eventual=False,
    retry=None,
    timeout=None,
)

Represent the state of a given execution of a Query.

Parameters

Name	Description
query	`Query` Query object holding permanent configuration (i.e. things that don't change on with each page in a results set).
client	`Client` The client used to make a request.
limit	`int` (Optional) Limit the number of results returned.
offset	`int` (Optional) Offset used to begin a query.
start_cursor	`bytes` (Optional) Cursor to begin paging through query results.
end_cursor	`bytes` (Optional) Cursor to end paging through query results.
eventual	`bool` (Optional) Defaults to strongly consistent (False). Setting True will use eventual consistency, but cannot be used inside a transaction or will raise ValueError.
retry	`google.api_core.retry.Retry` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
timeout	`float` Time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.

Inheritance

builtins.object > google.api_core.page_iterator.Iterator > Iterator