docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/bigquery_v2.tabledata.html b/docs/dyn/bigquery_v2.tabledata.html
index da9535e..02d00e1 100644
--- a/docs/dyn/bigquery_v2.tabledata.html
+++ b/docs/dyn/bigquery_v2.tabledata.html
@@ -78,7 +78,7 @@
<code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body=None)</a></code></p>
<p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, datasetId, tableId, selectedFields=None, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
+ <code><a href="#list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, selectedFields=None, startIndex=None)</a></code></p>
<p class="firstline">Retrieves table data from a specified set of rows. Requires the READER dataset role.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -96,18 +96,18 @@
The object takes the form of:
{
- "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
- "kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response.
- "rows": [ # The rows to insert.
+ "kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response.
+ "templateSuffix": "A String", # If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
+ "ignoreUnknownValues": True or False, # [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
+ "skipInvalidRows": True or False, # [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
+ "rows": [ # The rows to insert.
{
- "insertId": "A String", # [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.
- "json": { # Represents a single JSON object. # [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema.
- "a_key": "",
+ "insertId": "A String", # [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.
+ "json": { # Represents a single JSON object. # [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema.
+ "a_key": "",
},
},
],
- "skipInvalidRows": True or False, # [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
- "templateSuffix": "A String", # If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
}
@@ -115,53 +115,53 @@
An object of the form:
{
- "kind": "bigquery#tableDataInsertAllResponse", # The resource type of the response.
- "insertErrors": [ # An array of errors for rows that were not inserted.
+ "insertErrors": [ # An array of errors for rows that were not inserted.
{
- "index": 42, # The index of the row that error applies to.
- "errors": [ # Error information for the row indicated by the index property.
+ "errors": [ # Error information for the row indicated by the index property.
{
- "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
- "reason": "A String", # A short error code that summarizes the error.
- "message": "A String", # A human-readable description of the error.
- "location": "A String", # Specifies where the error occurred, if present.
+ "reason": "A String", # A short error code that summarizes the error.
+ "message": "A String", # A human-readable description of the error.
+ "location": "A String", # Specifies where the error occurred, if present.
+ "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
},
],
+ "index": 42, # The index of the row that error applies to.
},
],
+ "kind": "bigquery#tableDataInsertAllResponse", # The resource type of the response.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectId, datasetId, tableId, selectedFields=None, pageToken=None, maxResults=None, startIndex=None)</code>
+ <code class="details" id="list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, selectedFields=None, startIndex=None)</code>
<pre>Retrieves table data from a specified set of rows. Requires the READER dataset role.
Args:
projectId: string, Project ID of the table to read (required)
datasetId: string, Dataset ID of the table to read (required)
tableId: string, Table ID of the table to read (required)
- selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned
pageToken: string, Page token, returned by a previous call, identifying the result set
maxResults: integer, Maximum number of results to return
+ selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned
startIndex: string, Zero-based index of the starting row to read
Returns:
An object of the form:
{
- "rows": [ # Rows of results.
+ "totalRows": "A String", # The total number of rows in the complete table.
+ "etag": "A String", # A hash of this page of results.
+ "rows": [ # Rows of results.
{
- "f": [ # Represents a single row in the result set, consisting of one or more fields.
+ "f": [ # Represents a single row in the result set, consisting of one or more fields.
{
- "v": "",
+ "v": "",
},
],
},
],
- "kind": "bigquery#tableDataList", # The resource type of the response.
- "etag": "A String", # A hash of this page of results.
- "totalRows": "A String", # The total number of rows in the complete table.
- "pageToken": "A String", # A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
+ "pageToken": "A String", # A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
+ "kind": "bigquery#tableDataList", # The resource type of the response.
}</pre>
</div>
@@ -174,7 +174,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>