Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(bigquery): fix links to REST API in docstrings #9436

Merged
merged 3 commits into from
Oct 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions bigquery/google/cloud/bigquery/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ def list_datasets(
filter (str):
Optional. An expression for filtering the results by label.
For syntax, see
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list#filter.
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list#body.QUERY_PARAMETERS.filter
max_results (int):
Optional. Maximum number of datasets to return.
page_token (str):
Expand Down Expand Up @@ -1320,7 +1320,7 @@ def load_table_from_uri(
"""Starts a job for loading data into a table from CloudStorage.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationload

Arguments:
source_uris (Union[str, Sequence[str]]):
Expand Down Expand Up @@ -1858,7 +1858,7 @@ def copy_table(
"""Copy one or more tables to another table.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.copy
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationtablecopy

Arguments:
sources (Union[ \
Expand Down Expand Up @@ -1949,7 +1949,7 @@ def extract_table(
"""Start a job to extract a table into Cloud Storage files.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationextract

Arguments:
source (Union[ \
Expand Down Expand Up @@ -2020,7 +2020,7 @@ def query(
"""Run a SQL query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationquery

Arguments:
query (str):
Expand Down
4 changes: 2 additions & 2 deletions bigquery/google/cloud/bigquery/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ class DatasetReference(object):
"""DatasetReferences are pointers to datasets.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#datasetreference

Args:
project (str): The ID of the project
Expand Down Expand Up @@ -346,7 +346,7 @@ class Dataset(object):
"""Datasets are containers for tables.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource-dataset

Args:
dataset_ref (Union[google.cloud.bigquery.dataset.DatasetReference, str]):
Expand Down
122 changes: 61 additions & 61 deletions bigquery/google/cloud/bigquery/job.py

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion bigquery/google/cloud/bigquery/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ class ModelReference(object):
"""ModelReferences are pointers to models.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/models
https://cloud.google.com/bigquery/docs/reference/rest/v2/models#modelreference
"""

def __init__(self):
Expand Down
20 changes: 10 additions & 10 deletions bigquery/google/cloud/bigquery/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ def cache_hit(self):
"""Query results served from cache.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#cacheHit
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.cache_hit

Returns:
Optional[bool]:
Expand All @@ -487,7 +487,7 @@ def complete(self):
"""Server completed query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#jobComplete
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.job_complete

Returns:
Optional[bool]:
Expand All @@ -501,7 +501,7 @@ def errors(self):
"""Errors generated by the query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#errors
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.errors

Returns:
Optional[List[Mapping]]:
Expand All @@ -515,7 +515,7 @@ def job_id(self):
"""Job ID of the query job these results are from.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#jobReference
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.job_reference

Returns:
str: Job ID of the query job.
Expand All @@ -527,7 +527,7 @@ def page_token(self):
"""Token for fetching next bach of results.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#pageToken
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.page_token

Returns:
Optional[str]: Token generated on the server (None until set by the server).
Expand All @@ -539,7 +539,7 @@ def total_rows(self):
"""Total number of rows returned by the query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#totalRows
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.total_rows

Returns:
Optional[int}: Count generated on the server (None until set by the server).
Expand All @@ -553,7 +553,7 @@ def total_bytes_processed(self):
"""Total number of bytes processed by the query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#totalBytesProcessed
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.total_bytes_processed

Returns:
Optional[int]: Count generated on the server (None until set by the server).
Expand All @@ -567,7 +567,7 @@ def num_dml_affected_rows(self):
"""Total number of rows affected by a DML query.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#numDmlAffectedRows
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.num_dml_affected_rows

Returns:
Optional[int]: Count generated on the server (None until set by the server).
Expand All @@ -581,7 +581,7 @@ def rows(self):
"""Query results.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#rows
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.rows

Returns:
Optional[List[google.cloud.bigquery.table.Row]]:
Expand All @@ -594,7 +594,7 @@ def schema(self):
"""Schema for query results.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#schema
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query#body.QueryResponse.FIELDS.schema

Returns:
Optional[List[SchemaField]]:
Expand Down
10 changes: 5 additions & 5 deletions bigquery/google/cloud/bigquery/routine.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ def return_type(self):
time.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#resource-routine
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Routine.FIELDS.return_type
"""
resource = self._properties.get(self._PROPERTY_TO_API_FIELD["return_type"])
if not resource:
Expand Down Expand Up @@ -277,7 +277,7 @@ class RoutineArgument(object):
"""Input/output argument of a function or a stored procedure.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#argument

Args:
``**kwargs`` (Dict):
Expand Down Expand Up @@ -317,7 +317,7 @@ def kind(self):
``ANY_TYPE``.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#ArgumentKind
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Argument.FIELDS.argument_kind
"""
return self._properties.get(self._PROPERTY_TO_API_FIELD["kind"])

Expand All @@ -340,7 +340,7 @@ def data_type(self):
of a variable, e.g., a function argument.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/StandardSqlDataType
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#Argument.FIELDS.data_type
"""
resource = self._properties.get(self._PROPERTY_TO_API_FIELD["data_type"])
if not resource:
Expand Down Expand Up @@ -400,7 +400,7 @@ class RoutineReference(object):
"""A pointer to a routine.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines
https://cloud.google.com/bigquery/docs/reference/rest/v2/routines#routinereference
"""

def __init__(self):
Expand Down
10 changes: 5 additions & 5 deletions bigquery/google/cloud/bigquery/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ class SchemaField(object):
name (str): the name of the field.

field_type (str): the type of the field. See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.type

mode (str): the mode of the field. See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
mode (str): the mode of the field. See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode

description (Optional[str]): description for the field.

Expand Down Expand Up @@ -103,7 +103,7 @@ def field_type(self):
"""str: The type of the field.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.type
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.type
"""
return self._field_type

Expand All @@ -112,7 +112,7 @@ def mode(self):
"""str: The mode of the field.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#schema.fields.mode
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#TableFieldSchema.FIELDS.mode
"""
return self._mode

Expand Down
4 changes: 2 additions & 2 deletions bigquery/google/cloud/bigquery/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ class TableReference(object):
"""TableReferences are pointers to tables.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablereference

Args:
dataset_ref (google.cloud.bigquery.dataset.DatasetReference):
Expand Down Expand Up @@ -364,7 +364,7 @@ class Table(object):
"""Tables represent a set of rows whose values correspond to a schema.

See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource-table

Args:
table_ref (Union[google.cloud.bigquery.table.TableReference, str]):
Expand Down