Skip to content

Commit

Permalink
BigQuery: Documentation clarification for page_token (#4784)
Browse files Browse the repository at this point in the history
  • Loading branch information
chemelnucfin authored Jan 25, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 9f88d8d commit 7714d0c
Showing 1 changed file with 41 additions and 20 deletions.
61 changes: 41 additions & 20 deletions bigquery/google/cloud/bigquery/client.py
Original file line number Diff line number Diff line change
@@ -134,13 +134,17 @@ def list_projects(self, max_results=None, page_token=None,
https://cloud.google.com/bigquery/docs/reference/rest/v2/projects/list
:type max_results: int
:param max_results: maximum number of projects to return, If not
passed, defaults to a value set by the API.
:param max_results: (Optional) maximum number of projects to return,
If not passed, defaults to a value set by the API.
:type page_token: str
:param page_token: opaque marker for the next "page" of projects. If
not passed, the API will return the first page of
projects.
:param page_token:
(Optional) Token representing a cursor into the projects. If
not passed, the API will return the first page of projects.
The token marks the beginning of the iterator to be returned
and the value of the ``page_token`` can be accessed at
``next_page_token`` of the
:class:`~google.api_core.page_iterator.HTTPIterator`.
:type retry: :class:`google.api_core.retry.Retry`
:param retry: (Optional) How to retry the RPC.
@@ -169,18 +173,22 @@ def list_datasets(self, include_all=False, filter=None, max_results=None,
:param include_all: True if results include hidden datasets.
:type filter: str
:param filter: an expression for filtering the results by label.
For syntax, see
:param filter: (Optional) an expression for filtering the results by
label. For syntax, see
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list#filter.
:type max_results: int
:param max_results: maximum number of datasets to return, If not
passed, defaults to a value set by the API.
:param max_results: (Optional) maximum number of datasets to return,
if not passed, defaults to a value set by the API.
:type page_token: str
:param page_token: opaque marker for the next "page" of datasets. If
not passed, the API will return the first page of
datasets.
:param page_token:
(Optional) Token representing a cursor into the datasets. If
not passed, the API will return the first page of datasets.
The token marks the beginning of the iterator to be returned
and the value of the ``page_token`` can be accessed at
``next_page_token`` of the
:class:`~google.api_core.page_iterator.HTTPIterator`.
:type retry: :class:`google.api_core.retry.Retry`
:param retry: (Optional) How to retry the RPC.
@@ -410,9 +418,13 @@ def list_tables(self, dataset, max_results=None, page_token=None,
If not passed, defaults to a value set by the API.
:type page_token: str
:param page_token: (Optional) Opaque marker for the next "page" of
datasets. If not passed, the API will return the
first page of datasets.
:param page_token:
(Optional) Token representing a cursor into the tables. If not
passed, the API will return the first page of tables. The
token marks the beginning of the iterator to be returned and
the value of the ``page_token`` can be accessed at
``next_page_token`` of the
:class:`~google.api_core.page_iterator.HTTPIterator`.
:type retry: :class:`google.api_core.retry.Retry`
:param retry: (Optional) How to retry the RPC.
@@ -644,9 +656,13 @@ def list_jobs(self, max_results=None, page_token=None, all_users=None,
passed, defaults to a value set by the API.
:type page_token: str
:param page_token: opaque marker for the next "page" of jobs. If
not passed, the API will return the first page of
jobs.
:param page_token:
(Optional) Opaque marker for the next "page" of jobs. If not
passed, the API will return the first page of jobs. The token
marks the beginning of the iterator to be returned and the
value of the ``page_token`` can be accessed at
``next_page_token`` of
:class:`~google.api_core.page_iterator.HTTPIterator`.
:type all_users: bool
:param all_users: if true, include jobs owned by all users in the
@@ -1225,11 +1241,16 @@ def list_rows(self, table, selected_fields=None, max_results=None,
:class:`~google.cloud.bigquery.table.TableReference`.
:type max_results: int
:param max_results: maximum number of rows to return.
:param max_results: (Optional) maximum number of rows to return.
:type page_token: str
:param page_token: (Optional) Token representing a cursor into the
table's rows.
table's rows. If not passed, the API will return
the first page of the rows. The token marks the
beginning of the iterator to be returned and the
value of the ``page_token`` can be accessed at
``next_page_token`` of the
:class:`~google.cloud.bigquery.table.RowIterator`.
:type start_index: int
:param start_index: (Optional) The zero-based index of the starting

0 comments on commit 7714d0c

Please sign in to comment.