add placeholder for client code

google/cloud/spanner_admin_database_v1/types/common.py

@@ -24,7 +24,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.admin.database.v1",
+    package="google.spanner.admin.database.v1.gapic_generated",
     manifest={
         "DatabaseDialect",
         "OperationProgress",

google/cloud/spanner_admin_instance_v1/types/common.py

@@ -23,7 +23,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.admin.instance.v1",
+    package="google.spanner.admin.instance.v1.gapic_generated",
     manifest={
         "FulfillmentPeriod",
         "OperationProgress",

google/cloud/spanner_v1/types/commit_response.py

@@ -23,15 +23,15 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.v1",
+    package="google.spanner.v1.gapic_generated",
     manifest={
         "CommitResponse",
     },
 )
 
 
 class CommitResponse(proto.Message):
-    r"""The response for [Commit][google.spanner.v1.Spanner.Commit].
+    r"""The response for [Commit][google.spanner.v1.gapic_generated.Spanner.Commit].
 
     Attributes:
         commit_timestamp (google.protobuf.timestamp_pb2.Timestamp):
@@ -40,7 +40,7 @@ class CommitResponse(proto.Message):
         commit_stats (google.cloud.spanner_v1.types.CommitResponse.CommitStats):
             The statistics about this Commit. Not returned by default.
             For more information, see
-            [CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
+            [CommitRequest.return_commit_stats][google.spanner.v1.gapic_generated.CommitRequest.return_commit_stats].
     """
 
     class CommitStats(proto.Message):

google/cloud/spanner_v1/types/keys.py

@@ -23,7 +23,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.v1",
+    package="google.spanner.v1.gapic_generated",
     manifest={
         "KeyRange",
         "KeySet",
@@ -40,7 +40,7 @@ class KeyRange(proto.Message):
     Keys are represented by lists, where the ith value in the list
     corresponds to the ith component of the table or index primary key.
     Individual values are encoded as described
-    [here][google.spanner.v1.TypeCode].
+    [here][google.spanner.v1.gapic_generated.TypeCode].
 
     For example, consider the following table definition:
 
@@ -217,10 +217,10 @@ class KeySet(proto.Message):
             exactly as many elements as there are columns in the primary
             or index key with which this ``KeySet`` is used. Individual
             key values are encoded as described
-            [here][google.spanner.v1.TypeCode].
+            [here][google.spanner.v1.gapic_generated.TypeCode].
         ranges (MutableSequence[google.cloud.spanner_v1.types.KeyRange]):
             A list of key ranges. See
-            [KeyRange][google.spanner.v1.KeyRange] for more information
+            [KeyRange][google.spanner.v1.gapic_generated.KeyRange] for more information
             about key range specifications.
         all_ (bool):
             For convenience ``all`` can be set to ``true`` to indicate

google/cloud/spanner_v1/types/mutation.py

@@ -24,7 +24,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.v1",
+    package="google.spanner.v1.gapic_generated",
     manifest={
         "Mutation",
     },
@@ -34,7 +34,7 @@
 class Mutation(proto.Message):
     r"""A modification to one or more Cloud Spanner rows. Mutations can be
     applied to a Cloud Spanner database by sending them in a
-    [Commit][google.spanner.v1.Spanner.Commit] call.
+    [Commit][google.spanner.v1.gapic_generated.Spanner.Commit] call.
 
     This message has `oneof`_ fields (mutually exclusive fields).
     For each oneof, at most one member field can be set at the same time.
@@ -57,25 +57,25 @@ class Mutation(proto.Message):
 
             This field is a member of `oneof`_ ``operation``.
         insert_or_update (google.cloud.spanner_v1.types.Mutation.Write):
-            Like [insert][google.spanner.v1.Mutation.insert], except
+            Like [insert][google.spanner.v1.gapic_generated.Mutation.insert], except
             that if the row already exists, then its column values are
             overwritten with the ones provided. Any column values not
             explicitly written are preserved.
 
             When using
-            [insert_or_update][google.spanner.v1.Mutation.insert_or_update],
+            [insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update],
             just as when using
-            [insert][google.spanner.v1.Mutation.insert], all
+            [insert][google.spanner.v1.gapic_generated.Mutation.insert], all
             ``NOT NULL`` columns in the table must be given a value.
             This holds true even when the row already exists and will
             therefore actually be updated.
 
             This field is a member of `oneof`_ ``operation``.
         replace (google.cloud.spanner_v1.types.Mutation.Write):
-            Like [insert][google.spanner.v1.Mutation.insert], except
+            Like [insert][google.spanner.v1.gapic_generated.Mutation.insert], except
             that if the row already exists, it is deleted, and the
             column values provided are inserted instead. Unlike
-            [insert_or_update][google.spanner.v1.Mutation.insert_or_update],
+            [insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update],
             this means any values not explicitly written become
             ``NULL``.
 
@@ -93,18 +93,18 @@ class Mutation(proto.Message):
     """
 
     class Write(proto.Message):
-        r"""Arguments to [insert][google.spanner.v1.Mutation.insert],
-        [update][google.spanner.v1.Mutation.update],
-        [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and
-        [replace][google.spanner.v1.Mutation.replace] operations.
+        r"""Arguments to [insert][google.spanner.v1.gapic_generated.Mutation.insert],
+        [update][google.spanner.v1.gapic_generated.Mutation.update],
+        [insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update], and
+        [replace][google.spanner.v1.gapic_generated.Mutation.replace] operations.
 
         Attributes:
             table (str):
                 Required. The table whose rows will be
                 written.
             columns (MutableSequence[str]):
                 The names of the columns in
-                [table][google.spanner.v1.Mutation.Write.table] to be
+                [table][google.spanner.v1.gapic_generated.Mutation.Write.table] to be
                 written.
 
                 The list of columns must contain enough columns to allow
@@ -116,13 +116,13 @@ class Write(proto.Message):
                 written, one for each entry in ``values``. Each list in
                 ``values`` must have exactly as many entries as there are
                 entries in
-                [columns][google.spanner.v1.Mutation.Write.columns] above.
+                [columns][google.spanner.v1.gapic_generated.Mutation.Write.columns] above.
                 Sending multiple lists is equivalent to sending multiple
                 ``Mutation``\ s, each containing one ``values`` entry and
-                repeating [table][google.spanner.v1.Mutation.Write.table]
-                and [columns][google.spanner.v1.Mutation.Write.columns].
+                repeating [table][google.spanner.v1.gapic_generated.Mutation.Write.table]
+                and [columns][google.spanner.v1.gapic_generated.Mutation.Write.columns].
                 Individual values in each list are encoded as described
-                [here][google.spanner.v1.TypeCode].
+                [here][google.spanner.v1.gapic_generated.TypeCode].
         """
 
         table: str = proto.Field(
@@ -140,15 +140,15 @@ class Write(proto.Message):
         )
 
     class Delete(proto.Message):
-        r"""Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
+        r"""Arguments to [delete][google.spanner.v1.gapic_generated.Mutation.delete] operations.
 
         Attributes:
             table (str):
                 Required. The table whose rows will be
                 deleted.
             key_set (google.cloud.spanner_v1.types.KeySet):
                 Required. The primary keys of the rows within
-                [table][google.spanner.v1.Mutation.Delete.table] to delete.
+                [table][google.spanner.v1.gapic_generated.Mutation.Delete.table] to delete.
                 The primary keys must be specified in the order in which
                 they appear in the ``PRIMARY KEY()`` clause of the table's
                 equivalent DDL statement (the DDL statement used to create

google/cloud/spanner_v1/types/query_plan.py

@@ -23,7 +23,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.v1",
+    package="google.spanner.v1.gapic_generated",
     manifest={
         "PlanNode",
         "QueryPlan",
@@ -33,17 +33,17 @@
 
 class PlanNode(proto.Message):
     r"""Node information for nodes appearing in a
-    [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
+    [QueryPlan.plan_nodes][google.spanner.v1.gapic_generated.QueryPlan.plan_nodes].
 
     Attributes:
         index (int):
             The ``PlanNode``'s index in [node
-            list][google.spanner.v1.QueryPlan.plan_nodes].
+            list][google.spanner.v1.gapic_generated.QueryPlan.plan_nodes].
         kind (google.cloud.spanner_v1.types.PlanNode.Kind):
             Used to determine the type of node. May be needed for
             visualizing different kinds of nodes differently. For
             example, If the node is a
-            [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it
+            [SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] node, it
             will have a condensed representation which can be used to
             directly embed a description of the node in its parent.
         display_name (str):
@@ -53,7 +53,7 @@ class PlanNode(proto.Message):
             this parent.
         short_representation (google.cloud.spanner_v1.types.PlanNode.ShortRepresentation):
             Condensed representation for
-            [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
+            [SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] nodes.
         metadata (google.protobuf.struct_pb2.Struct):
             Attributes relevant to the node contained in a group of
             key-value pairs. For example, a Parameter Reference node
@@ -75,7 +75,7 @@ class PlanNode(proto.Message):
     """
 
     class Kind(proto.Enum):
-        r"""The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes
+        r"""The kind of [PlanNode][google.spanner.v1.gapic_generated.PlanNode]. Distinguishes
         between the two different kinds of nodes that can appear in a query
         plan.
 
@@ -100,7 +100,7 @@ class Kind(proto.Enum):
 
     class ChildLink(proto.Message):
         r"""Metadata associated with a parent-child relationship appearing in a
-        [PlanNode][google.spanner.v1.PlanNode].
+        [PlanNode][google.spanner.v1.gapic_generated.PlanNode].
 
         Attributes:
             child_index (int):
@@ -114,7 +114,7 @@ class ChildLink(proto.Message):
                 variable.
             variable (str):
                 Only present if the child node is
-                [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and
+                [SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] and
                 corresponds to an output variable of the parent node. The
                 field carries the name of the output variable. For example,
                 a ``TableScan`` operator that reads rows from a table will
@@ -139,7 +139,7 @@ class ChildLink(proto.Message):
 
     class ShortRepresentation(proto.Message):
         r"""Condensed representation of a node and its subtree. Only present for
-        ``SCALAR`` [PlanNode(s)][google.spanner.v1.PlanNode].
+        ``SCALAR`` [PlanNode(s)][google.spanner.v1.gapic_generated.PlanNode].
 
         Attributes:
             description (str):
@@ -206,7 +206,7 @@ class QueryPlan(proto.Message):
         plan_nodes (MutableSequence[google.cloud.spanner_v1.types.PlanNode]):
             The nodes in the query plan. Plan nodes are returned in
             pre-order starting with the plan root. Each
-            [PlanNode][google.spanner.v1.PlanNode]'s ``id`` corresponds
+            [PlanNode][google.spanner.v1.gapic_generated.PlanNode]'s ``id`` corresponds
             to its index in ``plan_nodes``.
     """
 

google/cloud/spanner_v1/types/result_set.py

@@ -26,7 +26,7 @@
 
 
 __protobuf__ = proto.module(
-    package="google.spanner.v1",
+    package="google.spanner.v1.gapic_generated",
     manifest={
         "ResultSet",
         "PartialResultSet",
@@ -37,31 +37,31 @@
 
 
 class ResultSet(proto.Message):
-    r"""Results from [Read][google.spanner.v1.Spanner.Read] or
-    [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
+    r"""Results from [Read][google.spanner.v1.gapic_generated.Spanner.Read] or
+    [ExecuteSql][google.spanner.v1.gapic_generated.Spanner.ExecuteSql].
 
     Attributes:
         metadata (google.cloud.spanner_v1.types.ResultSetMetadata):
             Metadata about the result set, such as row
             type information.
         rows (MutableSequence[google.protobuf.struct_pb2.ListValue]):
             Each element in ``rows`` is a row whose format is defined by
-            [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type].
+            [metadata.row_type][google.spanner.v1.gapic_generated.ResultSetMetadata.row_type].
             The ith element in each row matches the ith field in
-            [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type].
+            [metadata.row_type][google.spanner.v1.gapic_generated.ResultSetMetadata.row_type].
             Elements are encoded based on type as described
-            [here][google.spanner.v1.TypeCode].
+            [here][google.spanner.v1.gapic_generated.TypeCode].
         stats (google.cloud.spanner_v1.types.ResultSetStats):
             Query plan and execution statistics for the SQL statement
             that produced this result set. These can be requested by
             setting
-            [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
+            [ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
             DML statements always produce stats containing the number of
             rows modified, unless executed using the
-            [ExecuteSqlRequest.QueryMode.PLAN][google.spanner.v1.ExecuteSqlRequest.QueryMode.PLAN]
-            [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
+            [ExecuteSqlRequest.QueryMode.PLAN][google.spanner.v1.gapic_generated.ExecuteSqlRequest.QueryMode.PLAN]
+            [ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
             Other fields may or may not be populated, based on the
-            [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
+            [ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
     """
 
     metadata: "ResultSetMetadata" = proto.Field(
@@ -97,15 +97,15 @@ class PartialResultSet(proto.Message):
             accommodate large rows and/or large values. Every N complete
             values defines a row, where N is equal to the number of
             entries in
-            [metadata.row_type.fields][google.spanner.v1.StructType.fields].
+            [metadata.row_type.fields][google.spanner.v1.gapic_generated.StructType.fields].
 
             Most values are encoded based on type as described
-            [here][google.spanner.v1.TypeCode].
+            [here][google.spanner.v1.gapic_generated.TypeCode].
 
             It is possible that the last value in values is "chunked",
             meaning that the rest of the value is sent in subsequent
             ``PartialResultSet``\ (s). This is denoted by the
-            [chunked_value][google.spanner.v1.PartialResultSet.chunked_value]
+            [chunked_value][google.spanner.v1.gapic_generated.PartialResultSet.chunked_value]
             field. Two or more chunked values can be merged to form a
             complete value as follows:
 
@@ -175,7 +175,7 @@ class PartialResultSet(proto.Message):
             containing the field value ``"World" = "W" + "orl" + "d"``.
         chunked_value (bool):
             If true, then the final value in
-            [values][google.spanner.v1.PartialResultSet.values] is
+            [values][google.spanner.v1.gapic_generated.PartialResultSet.values] is
             chunked, and must be combined with more values from
             subsequent ``PartialResultSet``\ s to obtain a complete
             field value.
@@ -190,7 +190,7 @@ class PartialResultSet(proto.Message):
             Query plan and execution statistics for the statement that
             produced this streaming result set. These can be requested
             by setting
-            [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode]
+            [ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode]
             and are sent only once with the last response in the stream.
             This field will also be present in the last response for DML
             statements.
@@ -222,8 +222,8 @@ class PartialResultSet(proto.Message):
 
 
 class ResultSetMetadata(proto.Message):
-    r"""Metadata about a [ResultSet][google.spanner.v1.ResultSet] or
-    [PartialResultSet][google.spanner.v1.PartialResultSet].
+    r"""Metadata about a [ResultSet][google.spanner.v1.gapic_generated.ResultSet] or
+    [PartialResultSet][google.spanner.v1.gapic_generated.PartialResultSet].
 
     Attributes:
         row_type (google.cloud.spanner_v1.types.StructType):
@@ -277,8 +277,8 @@ class ResultSetMetadata(proto.Message):
 
 class ResultSetStats(proto.Message):
     r"""Additional statistics about a
-    [ResultSet][google.spanner.v1.ResultSet] or
-    [PartialResultSet][google.spanner.v1.PartialResultSet].
+    [ResultSet][google.spanner.v1.gapic_generated.ResultSet] or
+    [PartialResultSet][google.spanner.v1.gapic_generated.PartialResultSet].
 
     This message has `oneof`_ fields (mutually exclusive fields).
     For each oneof, at most one member field can be set at the same time.
@@ -289,7 +289,7 @@ class ResultSetStats(proto.Message):
 
     Attributes:
         query_plan (google.cloud.spanner_v1.types.QueryPlan):
-            [QueryPlan][google.spanner.v1.QueryPlan] for the query
+            [QueryPlan][google.spanner.v1.gapic_generated.QueryPlan] for the query
             associated with this result.
         query_stats (google.protobuf.struct_pb2.Struct):
             Aggregated statistics from the execution of the query. Only