Class Iterator (2.4.0)

Version 2.4.0

• 2.20.1 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.0
• 2.13.2
• 2.12.0
• 2.11.1
• 2.10.0
• 2.9.0
• 2.8.3
• 2.7.2
• 2.6.2
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.6
• 2.0.1
• 1.15.5
• 1.14.0
• 1.13.2
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.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