docs: add documents for QueryPlanEntry and QueryPlanEntryStep (#344)

googleapis · Oct 27, 2020 · dca2e4c · dca2e4c
1 parent c9823d9
commit dca2e4c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -59,6 +59,8 @@ Job-Related Types
     job.CreateDisposition
     job.DestinationFormat
     job.Encoding
+    job.QueryPlanEntry
+    job.QueryPlanEntryStep
     job.QueryPriority
     job.SourceFormat
     job.WriteDisposition

diff --git a/google/cloud/bigquery/job.py b/google/cloud/bigquery/job.py
@@ -2844,7 +2844,7 @@ def query_plan(self):
         https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics2.FIELDS.query_plan
 
         Returns:
-            List[QueryPlanEntry]:
+            List[google.cloud.bigquery.job.QueryPlanEntry]:
                 mappings describing the query plan, or an empty list
                 if the query has not yet completed.
         """
@@ -3418,7 +3418,6 @@ class QueryPlanEntryStep(object):
 
     Args:
         kind (str): step type.
-
         substeps (List): names of substeps.
     """
 
@@ -3434,7 +3433,8 @@ def from_api_repr(cls, resource):
             resource (Dict): JSON representation of the entry.
 
         Returns:
-            QueryPlanEntryStep: new instance built from the resource.
+            google.cloud.bigquery.job.QueryPlanEntryStep:
+                New instance built from the resource.
         """
         return cls(kind=resource.get("kind"), substeps=resource.get("substeps", ()))
 
@@ -3464,7 +3464,7 @@ def from_api_repr(cls, resource):
                 ExplainQueryStage representation returned from API.
 
         Returns:
-            google.cloud.bigquery.QueryPlanEntry:
+            google.cloud.bigquery.job.QueryPlanEntry:
                 Query plan entry parsed from ``resource``.
         """
         entry = cls()