Commit696c443

and

authored

docs: explain retry behavior for DONE jobs (#532)

* docs: explain retry behavior for DONE jobs* Update google/cloud/bigquery/job/query.pyCo-authored-by: Tim Swast <swast@google.com>

1 parentbb9a94c commit696c443Copy full SHA for 696c443

File tree

+11

-4

lines changed

+11

-4

lines changed

Lines changed: 6 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -614,7 +614,9 @@ def done(self, retry=DEFAULT_RETRY, timeout=None, reload=True):`
`614`	`614`	`"""Checks if the job is complete.`
`615`	`615`
`616`	`616`	`Args:`
`617`		`- retry (Optional[google.api_core.retry.Retry]): How to retry the RPC.`
	`617`	`+ retry (Optional[google.api_core.retry.Retry]):`
	`618`	+ How to retry the RPC. If the job state is ``DONE``, retrying is aborted
	`619`	`+ early, as the job will not change anymore.`
`618`	`620`	`timeout (Optional[float]):`
`619`	`621`	`The number of seconds to wait for the underlying HTTP transport`
`620`	`622`	before using ``retry``.
`@@ -635,7 +637,9 @@ def result(self, retry=DEFAULT_RETRY, timeout=None):`
`635`	`637`	`"""Start the job and wait for it to complete and get the result.`
`636`	`638`
`637`	`639`	`Args:`
`638`		`- retry (Optional[google.api_core.retry.Retry]): How to retry the RPC.`
	`640`	`+ retry (Optional[google.api_core.retry.Retry]):`
	`641`	+ How to retry the RPC. If the job state is ``DONE``, retrying is aborted
	`642`	`+ early, as the job will not change anymore.`
`639`	`643`	`timeout (Optional[float]):`
`640`	`644`	`The number of seconds to wait for the underlying HTTP transport`
`641`	`645`	before using ``retry``.

Lines changed: 5 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -979,7 +979,8 @@ def done(self, retry=DEFAULT_RETRY, timeout=None, reload=True):`
`979`	`979`
`980`	`980`	`Args:`
`981`	`981`	`retry (Optional[google.api_core.retry.Retry]):`
`982`		`- How to retry the call that retrieves query results.`
	`982`	`+ How to retry the call that retrieves query results. If the job state is`
	`983`	+ ``DONE``, retrying is aborted early, as the job will not change anymore.
`983`	`984`	`timeout (Optional[float]):`
`984`	`985`	`The number of seconds to wait for the underlying HTTP transport`
`985`	`986`	before using ``retry``.
`@@ -1128,7 +1129,9 @@ def result(`
`1128`	`1129`	`max_results (Optional[int]):`
`1129`	`1130`	`The maximum total number of rows from this request.`
`1130`	`1131`	`retry (Optional[google.api_core.retry.Retry]):`
`1131`		`- How to retry the call that retrieves rows.`
	`1132`	`+ How to retry the call that retrieves rows. If the job state is`
	`1133`	+ ``DONE``, retrying is aborted early even if the results are not
	`1134`	`+ available, as this will not change anymore.`
`1132`	`1135`	`timeout (Optional[float]):`
`1133`	`1136`	`The number of seconds to wait for the underlying HTTP transport`
`1134`	`1137`	before using ``retry``.

Comments

(0)