docs: fix docstring types

Author: larkee

google/cloud/spanner_v1/_helpers.py

@@ -53,19 +53,19 @@ def _merge_query_options(base, merge):
     """Merge higher precedence QueryOptions with current QueryOptions.
 
     :type base:
-        :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+        :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
         or :class:`dict` or None
     :param base: The current QueryOptions that is intended for use.
 
     :type merge:
-        :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+        :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
         or :class:`dict` or None
     :param merge:
         The QueryOptions that have a higher priority than base. These options
         should overwrite the fields in base.
 
     :rtype:
-        :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+        :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
         or None
     :returns:
         QueryOptions object formed by merging the two given QueryOptions.
@@ -167,7 +167,7 @@ def _parse_value_pb(value_pb, field_type):
     :type value_pb: :class:`~google.protobuf.struct_pb2.Value`
     :param value_pb: protobuf to convert
 
-    :type field_type: :class:`~google.cloud.spanner_v1.Type`
+    :type field_type: :class:`~google.cloud.spanner_v1.types.Type`
     :param field_type: type code for the value
 
     :rtype: varies on field_type
@@ -220,7 +220,7 @@ def _parse_list_value_pbs(rows, row_type):
     :type rows: list of :class:`~google.protobuf.struct_pb2.ListValue`
     :param rows: row data returned from a read/query
 
-    :type row_type: :class:`~google.cloud.spanner_v1.StructType`
+    :type row_type: :class:`~google.cloud.spanner_v1.types.StructType`
     :param row_type: row schema specification
 
     :rtype: list of list of cell data

google/cloud/spanner_v1/backup.py

@@ -141,7 +141,7 @@ def size_bytes(self):
     def state(self):
         """State of this backup.
 
-        :rtype: :class:`~google.cloud.spanner_admin_database_v1.Backup.State`
+        :rtype: :class:`~google.cloud.spanner_admin_database_v1.types.Backup.State`
         :returns: an enum describing the state of the backup
         """
         return self._state
@@ -160,7 +160,7 @@ def referencing_databases(self):
     def from_pb(cls, backup_pb, instance):
         """Create an instance of this class from a protobuf message.
 
-        :type backup_pb: :class:`~google.spanner.admin.database.v1.Backup`
+        :type backup_pb: :class:`~google.cloud.spanner_admin_database_v1.types.Backup`
         :param backup_pb: A backup protobuf object.
 
         :type instance: :class:`~google.cloud.spanner_v1.instance.Instance`

google/cloud/spanner_v1/batch.py

@@ -190,7 +190,7 @@ def _make_write_pb(table, columns, values):
     :type values: list of lists
     :param values: Values to be modified.
 
-    :rtype: :class:`google.cloud.spanner_v1.Mutation.Write`
+    :rtype: :class:`google.cloud.spanner_v1.types.Mutation.Write`
     :returns: Write protobuf
     """
     return Mutation.Write(

google/cloud/spanner_v1/client.py

@@ -108,12 +108,12 @@ class Client(ClientWithProject):
         on the client. API Endpoint should be set through client_options.
 
     :type query_options:
-        :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+        :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
         or :class:`dict`
     :param query_options:
         (Optional) Query optimizer configuration to use for the given query.
         If a dict is provided, it must be of the same form as the protobuf
-        message :class:`~google.cloud.spanner_v1.QueryOptions`
+        message :class:`~google.cloud.spanner_v1.types.QueryOptions`
 
     :raises: :class:`ValueError <exceptions.ValueError>` if both ``read_only``
              and ``admin`` are :data:`True`
@@ -348,7 +348,7 @@ def list_instances(self, filter_="", page_size=None):
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns:
-            Iterator of :class:`~google.cloud.spanner_v1.instance.Instance`
+            Iterator of :class:`~google.cloud.spanner_admin_instance_v1.types.Instance`
             resources within the client's project.
         """
         metadata = _metadata_with_prefix(self.project_name)

google/cloud/spanner_v1/database.py

@@ -138,7 +138,7 @@ def from_pb(cls, database_pb, instance, pool=None):
         """Creates an instance of this class from a protobuf.
 
         :type database_pb:
-            :class:`~google.cloud.spanner_admin_instance_v1.Instance`
+            :class:`~google.cloud.spanner_admin_instance_v1.types.Instance`
         :param database_pb: A instance protobuf object.
 
         :type instance: :class:`~google.cloud.spanner_v1.instance.Instance`
@@ -199,7 +199,7 @@ def name(self):
     def state(self):
         """State of this database.
 
-        :rtype: :class:`~google.cloud.spanner_admin_database_v1.Database.State`
+        :rtype: :class:`~google.cloud.spanner_admin_database_v1.types.Database.State`
         :returns: an enum describing the state of the database
         """
         return self._state
@@ -218,7 +218,7 @@ def create_time(self):
     def restore_info(self):
         """Restore info for this database.
 
-        :rtype: :class:`~google.cloud.spanner_v1.database.RestoreInfo`
+        :rtype: :class:`~google.cloud.spanner_v1.types.RestoreInfo`
         :returns: an object representing the restore info for this database
         """
         return self._restore_info
@@ -429,12 +429,12 @@ def execute_partitioned_dml(
             required if parameters are passed.
 
         :type query_options:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
                 If a dict is provided, it must be of the same form as the protobuf
-                message :class:`~google.cloud.spanner_v1.QueryOptions`
+                message :class:`~google.cloud.spanner_v1.types.QueryOptions`
 
         :rtype: int
         :returns: Count of rows affected by the DML statement.
@@ -976,12 +976,12 @@ def generate_query_batches(
             differ.
 
         :type query_options:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
                 If a dict is provided, it must be of the same form as the protobuf
-                message :class:`~google.cloud.spanner_v1.QueryOptions`
+                message :class:`~google.cloud.spanner_v1.types.QueryOptions`
 
         :rtype: iterable of dict
         :returns:

google/cloud/spanner_v1/instance.py

@@ -398,7 +398,7 @@ def list_databases(self, page_size=None):
 
         :rtype: :class:`~google.api._ore.page_iterator.Iterator`
         :returns:
-            Iterator of :class:`~google.cloud.spanner_v1.database.Database`
+            Iterator of :class:`~google.cloud.spanner_admin_database_v1.types.Database`
             resources within the current instance.
         """
         metadata = _metadata_with_prefix(self.name)
@@ -429,6 +429,9 @@ def backup(self, backup_id, database="", expire_time=None, version_time=None):
             Optional. The version time that will be used to create the externally
             consistent copy of the database. If not present, it is the same as
             the `create_time` of the backup.
+
+        :rtype: :class:`~google.cloud.spanner_v1.backup.Backup`
+        :returns: a backup owned by this instance.
         """
         try:
             return Backup(
@@ -462,7 +465,7 @@ def list_backups(self, filter_="", page_size=None):
 
         :rtype: :class:`~google.api_core.page_iterator.Iterator`
         :returns:
-            Iterator of :class:`~google.cloud.spanner_v1.backup.Backup`
+            Iterator of :class:`~google.cloud.spanner_admin_database_v1.types.Backup`
             resources within the current instance.
         """
         metadata = _metadata_with_prefix(self.name)

google/cloud/spanner_v1/keyset.py

@@ -68,7 +68,7 @@ def __init__(
     def _to_pb(self):
         """Construct a KeyRange protobuf.
 
-        :rtype: :class:`~google.cloud.spanner_v1.KeyRange`
+        :rtype: :class:`~google.cloud.spanner_v1.types.KeyRange`
         :returns: protobuf corresponding to this instance.
         """
         kwargs = {}
@@ -139,7 +139,7 @@ def __init__(self, keys=(), ranges=(), all_=False):
     def _to_pb(self):
         """Construct a KeySet protobuf.
 
-        :rtype: :class:`~google.cloud.spanner_v1.KeySet`
+        :rtype: :class:`~google.cloud.spanner_v1.types.KeySet`
         :returns: protobuf corresponding to this instance.
         """
         if self.all_:

google/cloud/spanner_v1/param_types.py

@@ -33,10 +33,10 @@
 def Array(element_type):  # pylint: disable=invalid-name
     """Construct an array parameter type description protobuf.
 
-    :type element_type: :class:`~google.cloud.spanner_v1.Type`
+    :type element_type: :class:`~google.cloud.spanner_v1.types.Type`
     :param element_type: the type of elements of the array
 
-    :rtype: :class:`google.cloud.spanner_v1.Type`
+    :rtype: :class:`google.cloud.spanner_v1.types.Type`
     :returns: the appropriate array-type protobuf
     """
     return Type(code=TypeCode.ARRAY, array_element_type=element_type)
@@ -48,10 +48,10 @@ def StructField(name, field_type):  # pylint: disable=invalid-name
     :type name: str
     :param name: the name of the field
 
-    :type field_type: :class:`google.cloud.spanner_v1.Type`
+    :type field_type: :class:`google.cloud.spanner_v1.types.Type`
     :param field_type: the type of the field
 
-    :rtype: :class:`google.cloud.spanner_v1.StructType.Field`
+    :rtype: :class:`google.cloud.spanner_v1.types.StructType.Field`
     :returns: the appropriate struct-field-type protobuf
     """
     return StructType.Field(name=name, type_=field_type)
@@ -60,7 +60,7 @@ def StructField(name, field_type):  # pylint: disable=invalid-name
 def Struct(fields):  # pylint: disable=invalid-name
     """Construct a struct parameter type description protobuf.
 
-    :type fields: list of :class:`google.cloud.spanner_v1.StructType.Field`
+    :type fields: list of :class:`google.cloud.spanner_v1.types.StructType.Field`
     :param fields: the fields of the struct
 
     :rtype: :class:`type_pb2.Type`

google/cloud/spanner_v1/session.py

@@ -243,18 +243,18 @@ def execute_sql(
                        the names used in ``sql``.
 
         :type param_types:
-            dict, {str -> :class:`~google.spanner.v1.type_pb2.TypeCode`}
+            dict, {str -> :class:`~google.spanner.v1.types.TypeCode`}
         :param param_types: (Optional) explicit types for one or more param
                             values;  overrides default type detection on the
                             back-end.
 
         :type query_mode:
-            :class:`~google.spanner.v1.spanner_pb2.ExecuteSqlRequest.QueryMode`
+            :class:`~google.spanner.v1.types.ExecuteSqlRequest.QueryMode`
         :param query_mode: Mode governing return of results / query plan. See:
             `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options: (Optional) Options that are provided for query plan stability.
 

google/cloud/spanner_v1/snapshot.py

@@ -204,18 +204,18 @@ def execute_sql(
             required if parameters are passed.
 
         :type query_mode:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryMode`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryMode`
         :param query_mode: Mode governing return of results / query plan.
             See:
             `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
                 or :class:`dict`
         :param query_options:
                 (Optional) Query optimizer configuration to use for the given query.
                 If a dict is provided, it must be of the same form as the protobuf
-                message :class:`~google.cloud.spanner_v1.QueryOptions`
+                message :class:`~google.cloud.spanner_v1.types.QueryOptions`
 
         :type partition: bytes
         :param partition: (Optional) one of the partition tokens returned

google/cloud/spanner_v1/streamed.py

@@ -33,7 +33,7 @@ class StreamedResultSet(object):
     :type response_iterator:
     :param response_iterator:
         Iterator yielding
-        :class:`~google.cloud.spanner_v1.PartialResultSet`
+        :class:`~google.cloud.spanner_v1.types.PartialResultSet`
         instances.
 
     :type source: :class:`~google.cloud.spanner_v1.snapshot.Snapshot`
@@ -53,7 +53,7 @@ def __init__(self, response_iterator, source=None):
     def fields(self):
         """Field descriptors for result set columns.
 
-        :rtype: list of :class:`~google.cloud.spanner_v1.StructType.Field`
+        :rtype: list of :class:`~google.cloud.spanner_v1.types.StructType.Field`
         :returns: list of fields describing column names / types.
         """
         return self._metadata.row_type.fields
@@ -62,7 +62,7 @@ def fields(self):
     def metadata(self):
         """Result set metadata
 
-        :rtype: :class:`~google.cloud.spanner_v1.ResultSetMetadata`
+        :rtype: :class:`~google.cloud.spanner_v1.types.ResultSetMetadata`
         :returns: structure describing the results
         """
         return self._metadata
@@ -72,7 +72,7 @@ def stats(self):
         """Result set statistics
 
         :rtype:
-           :class:`~google.cloud.spanner_v1.ResultSetStats`
+           :class:`~google.cloud.spanner_v1.types.ResultSetStats`
         :returns: structure describing status about the response
         """
         return self._stats
@@ -201,7 +201,7 @@ class Unmergeable(ValueError):
     :type rhs: :class:`~google.protobuf.struct_pb2.Value`
     :param rhs: remaining value to be merged
 
-    :type type_: :class:`~google.cloud.spanner_v1.Type`
+    :type type_: :class:`~google.cloud.spanner_v1.types.Type`
     :param type_: field type of values being merged
     """
 

google/cloud/spanner_v1/transaction.py

@@ -202,13 +202,13 @@ def execute_update(
             required if parameters are passed.
 
         :type query_mode:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryMode`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryMode`
         :param query_mode: Mode governing return of results / query plan.
             See:
             `QueryMode <https://cloud.google.com/spanner/reference/rpc/google.spanner.v1#google.spanner.v1.ExecuteSqlRequest.QueryMode>`_.
 
         :type query_options:
-            :class:`~google.cloud.spanner_v1.ExecuteSqlRequest.QueryOptions`
+            :class:`~google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryOptions`
             or :class:`dict`
         :param query_options: (Optional) Options that are provided for query plan stability.