Skip to content

Commit dca2e4c

Browse files
docs: add documents for QueryPlanEntry and QueryPlanEntryStep (#344)
1 parent c9823d9 commit dca2e4c

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/reference.rst

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Job-Related Types
5959
job.CreateDisposition
6060
job.DestinationFormat
6161
job.Encoding
62+
job.QueryPlanEntry
63+
job.QueryPlanEntryStep
6264
job.QueryPriority
6365
job.SourceFormat
6466
job.WriteDisposition

google/cloud/bigquery/job.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -2844,7 +2844,7 @@ def query_plan(self):
28442844
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics2.FIELDS.query_plan
28452845
28462846
Returns:
2847-
List[QueryPlanEntry]:
2847+
List[google.cloud.bigquery.job.QueryPlanEntry]:
28482848
mappings describing the query plan, or an empty list
28492849
if the query has not yet completed.
28502850
"""
@@ -3418,7 +3418,6 @@ class QueryPlanEntryStep(object):
34183418
34193419
Args:
34203420
kind (str): step type.
3421-
34223421
substeps (List): names of substeps.
34233422
"""
34243423

@@ -3434,7 +3433,8 @@ def from_api_repr(cls, resource):
34343433
resource (Dict): JSON representation of the entry.
34353434
34363435
Returns:
3437-
QueryPlanEntryStep: new instance built from the resource.
3436+
google.cloud.bigquery.job.QueryPlanEntryStep:
3437+
New instance built from the resource.
34383438
"""
34393439
return cls(kind=resource.get("kind"), substeps=resource.get("substeps", ()))
34403440

@@ -3464,7 +3464,7 @@ def from_api_repr(cls, resource):
34643464
ExplainQueryStage representation returned from API.
34653465
34663466
Returns:
3467-
google.cloud.bigquery.QueryPlanEntry:
3467+
google.cloud.bigquery.job.QueryPlanEntry:
34683468
Query plan entry parsed from ``resource``.
34693469
"""
34703470
entry = cls()

0 commit comments

Comments
 (0)