Skip to content

Commit a9852c8

Browse files
committed
add placeholder for client code
1 parent 7fe1257 commit a9852c8

File tree

14 files changed

+364
-360
lines changed

14 files changed

+364
-360
lines changed

google/cloud/spanner_admin_database_v1/types/backup.py

Lines changed: 47 additions & 47 deletions
Large diffs are not rendered by default.

google/cloud/spanner_admin_database_v1/types/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525

2626
__protobuf__ = proto.module(
27-
package="google.spanner.admin.database.v1",
27+
package="google.spanner.admin.database.v1.gapic_generated",
2828
manifest={
2929
"DatabaseDialect",
3030
"OperationProgress",

google/cloud/spanner_admin_database_v1/types/spanner_database_admin.py

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

google/cloud/spanner_admin_instance_v1/types/common.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424

2525
__protobuf__ = proto.module(
26-
package="google.spanner.admin.instance.v1",
26+
package="google.spanner.admin.instance.v1.gapic_generated",
2727
manifest={
2828
"FulfillmentPeriod",
2929
"OperationProgress",

google/cloud/spanner_admin_instance_v1/types/spanner_instance_admin.py

Lines changed: 81 additions & 81 deletions
Large diffs are not rendered by default.

google/cloud/spanner_v1/types/commit_response.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,15 @@
2323

2424

2525
__protobuf__ = proto.module(
26-
package="google.spanner.v1",
26+
package="google.spanner.v1.gapic_generated",
2727
manifest={
2828
"CommitResponse",
2929
},
3030
)
3131

3232

3333
class CommitResponse(proto.Message):
34-
r"""The response for [Commit][google.spanner.v1.Spanner.Commit].
34+
r"""The response for [Commit][google.spanner.v1.gapic_generated.Spanner.Commit].
3535
3636
Attributes:
3737
commit_timestamp (google.protobuf.timestamp_pb2.Timestamp):
@@ -40,7 +40,7 @@ class CommitResponse(proto.Message):
4040
commit_stats (google.cloud.spanner_v1.types.CommitResponse.CommitStats):
4141
The statistics about this Commit. Not returned by default.
4242
For more information, see
43-
[CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
43+
[CommitRequest.return_commit_stats][google.spanner.v1.gapic_generated.CommitRequest.return_commit_stats].
4444
"""
4545

4646
class CommitStats(proto.Message):

google/cloud/spanner_v1/types/keys.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424

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

google/cloud/spanner_v1/types/mutation.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525

2626
__protobuf__ = proto.module(
27-
package="google.spanner.v1",
27+
package="google.spanner.v1.gapic_generated",
2828
manifest={
2929
"Mutation",
3030
},
@@ -34,7 +34,7 @@
3434
class Mutation(proto.Message):
3535
r"""A modification to one or more Cloud Spanner rows. Mutations can be
3636
applied to a Cloud Spanner database by sending them in a
37-
[Commit][google.spanner.v1.Spanner.Commit] call.
37+
[Commit][google.spanner.v1.gapic_generated.Spanner.Commit] call.
3838
3939
This message has `oneof`_ fields (mutually exclusive fields).
4040
For each oneof, at most one member field can be set at the same time.
@@ -57,25 +57,25 @@ class Mutation(proto.Message):
5757
5858
This field is a member of `oneof`_ ``operation``.
5959
insert_or_update (google.cloud.spanner_v1.types.Mutation.Write):
60-
Like [insert][google.spanner.v1.Mutation.insert], except
60+
Like [insert][google.spanner.v1.gapic_generated.Mutation.insert], except
6161
that if the row already exists, then its column values are
6262
overwritten with the ones provided. Any column values not
6363
explicitly written are preserved.
6464
6565
When using
66-
[insert_or_update][google.spanner.v1.Mutation.insert_or_update],
66+
[insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update],
6767
just as when using
68-
[insert][google.spanner.v1.Mutation.insert], all
68+
[insert][google.spanner.v1.gapic_generated.Mutation.insert], all
6969
``NOT NULL`` columns in the table must be given a value.
7070
This holds true even when the row already exists and will
7171
therefore actually be updated.
7272
7373
This field is a member of `oneof`_ ``operation``.
7474
replace (google.cloud.spanner_v1.types.Mutation.Write):
75-
Like [insert][google.spanner.v1.Mutation.insert], except
75+
Like [insert][google.spanner.v1.gapic_generated.Mutation.insert], except
7676
that if the row already exists, it is deleted, and the
7777
column values provided are inserted instead. Unlike
78-
[insert_or_update][google.spanner.v1.Mutation.insert_or_update],
78+
[insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update],
7979
this means any values not explicitly written become
8080
``NULL``.
8181
@@ -93,18 +93,18 @@ class Mutation(proto.Message):
9393
"""
9494

9595
class Write(proto.Message):
96-
r"""Arguments to [insert][google.spanner.v1.Mutation.insert],
97-
[update][google.spanner.v1.Mutation.update],
98-
[insert_or_update][google.spanner.v1.Mutation.insert_or_update], and
99-
[replace][google.spanner.v1.Mutation.replace] operations.
96+
r"""Arguments to [insert][google.spanner.v1.gapic_generated.Mutation.insert],
97+
[update][google.spanner.v1.gapic_generated.Mutation.update],
98+
[insert_or_update][google.spanner.v1.gapic_generated.Mutation.insert_or_update], and
99+
[replace][google.spanner.v1.gapic_generated.Mutation.replace] operations.
100100
101101
Attributes:
102102
table (str):
103103
Required. The table whose rows will be
104104
written.
105105
columns (MutableSequence[str]):
106106
The names of the columns in
107-
[table][google.spanner.v1.Mutation.Write.table] to be
107+
[table][google.spanner.v1.gapic_generated.Mutation.Write.table] to be
108108
written.
109109
110110
The list of columns must contain enough columns to allow
@@ -116,13 +116,13 @@ class Write(proto.Message):
116116
written, one for each entry in ``values``. Each list in
117117
``values`` must have exactly as many entries as there are
118118
entries in
119-
[columns][google.spanner.v1.Mutation.Write.columns] above.
119+
[columns][google.spanner.v1.gapic_generated.Mutation.Write.columns] above.
120120
Sending multiple lists is equivalent to sending multiple
121121
``Mutation``\ s, each containing one ``values`` entry and
122-
repeating [table][google.spanner.v1.Mutation.Write.table]
123-
and [columns][google.spanner.v1.Mutation.Write.columns].
122+
repeating [table][google.spanner.v1.gapic_generated.Mutation.Write.table]
123+
and [columns][google.spanner.v1.gapic_generated.Mutation.Write.columns].
124124
Individual values in each list are encoded as described
125-
[here][google.spanner.v1.TypeCode].
125+
[here][google.spanner.v1.gapic_generated.TypeCode].
126126
"""
127127

128128
table: str = proto.Field(
@@ -140,15 +140,15 @@ class Write(proto.Message):
140140
)
141141

142142
class Delete(proto.Message):
143-
r"""Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
143+
r"""Arguments to [delete][google.spanner.v1.gapic_generated.Mutation.delete] operations.
144144
145145
Attributes:
146146
table (str):
147147
Required. The table whose rows will be
148148
deleted.
149149
key_set (google.cloud.spanner_v1.types.KeySet):
150150
Required. The primary keys of the rows within
151-
[table][google.spanner.v1.Mutation.Delete.table] to delete.
151+
[table][google.spanner.v1.gapic_generated.Mutation.Delete.table] to delete.
152152
The primary keys must be specified in the order in which
153153
they appear in the ``PRIMARY KEY()`` clause of the table's
154154
equivalent DDL statement (the DDL statement used to create

google/cloud/spanner_v1/types/query_plan.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424

2525
__protobuf__ = proto.module(
26-
package="google.spanner.v1",
26+
package="google.spanner.v1.gapic_generated",
2727
manifest={
2828
"PlanNode",
2929
"QueryPlan",
@@ -33,17 +33,17 @@
3333

3434
class PlanNode(proto.Message):
3535
r"""Node information for nodes appearing in a
36-
[QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
36+
[QueryPlan.plan_nodes][google.spanner.v1.gapic_generated.QueryPlan.plan_nodes].
3737
3838
Attributes:
3939
index (int):
4040
The ``PlanNode``'s index in [node
41-
list][google.spanner.v1.QueryPlan.plan_nodes].
41+
list][google.spanner.v1.gapic_generated.QueryPlan.plan_nodes].
4242
kind (google.cloud.spanner_v1.types.PlanNode.Kind):
4343
Used to determine the type of node. May be needed for
4444
visualizing different kinds of nodes differently. For
4545
example, If the node is a
46-
[SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it
46+
[SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] node, it
4747
will have a condensed representation which can be used to
4848
directly embed a description of the node in its parent.
4949
display_name (str):
@@ -53,7 +53,7 @@ class PlanNode(proto.Message):
5353
this parent.
5454
short_representation (google.cloud.spanner_v1.types.PlanNode.ShortRepresentation):
5555
Condensed representation for
56-
[SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
56+
[SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] nodes.
5757
metadata (google.protobuf.struct_pb2.Struct):
5858
Attributes relevant to the node contained in a group of
5959
key-value pairs. For example, a Parameter Reference node
@@ -75,7 +75,7 @@ class PlanNode(proto.Message):
7575
"""
7676

7777
class Kind(proto.Enum):
78-
r"""The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes
78+
r"""The kind of [PlanNode][google.spanner.v1.gapic_generated.PlanNode]. Distinguishes
7979
between the two different kinds of nodes that can appear in a query
8080
plan.
8181
@@ -100,7 +100,7 @@ class Kind(proto.Enum):
100100

101101
class ChildLink(proto.Message):
102102
r"""Metadata associated with a parent-child relationship appearing in a
103-
[PlanNode][google.spanner.v1.PlanNode].
103+
[PlanNode][google.spanner.v1.gapic_generated.PlanNode].
104104
105105
Attributes:
106106
child_index (int):
@@ -114,7 +114,7 @@ class ChildLink(proto.Message):
114114
variable.
115115
variable (str):
116116
Only present if the child node is
117-
[SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and
117+
[SCALAR][google.spanner.v1.gapic_generated.PlanNode.Kind.SCALAR] and
118118
corresponds to an output variable of the parent node. The
119119
field carries the name of the output variable. For example,
120120
a ``TableScan`` operator that reads rows from a table will
@@ -139,7 +139,7 @@ class ChildLink(proto.Message):
139139

140140
class ShortRepresentation(proto.Message):
141141
r"""Condensed representation of a node and its subtree. Only present for
142-
``SCALAR`` [PlanNode(s)][google.spanner.v1.PlanNode].
142+
``SCALAR`` [PlanNode(s)][google.spanner.v1.gapic_generated.PlanNode].
143143
144144
Attributes:
145145
description (str):
@@ -206,7 +206,7 @@ class QueryPlan(proto.Message):
206206
plan_nodes (MutableSequence[google.cloud.spanner_v1.types.PlanNode]):
207207
The nodes in the query plan. Plan nodes are returned in
208208
pre-order starting with the plan root. Each
209-
[PlanNode][google.spanner.v1.PlanNode]'s ``id`` corresponds
209+
[PlanNode][google.spanner.v1.gapic_generated.PlanNode]'s ``id`` corresponds
210210
to its index in ``plan_nodes``.
211211
"""
212212

google/cloud/spanner_v1/types/result_set.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727

2828
__protobuf__ = proto.module(
29-
package="google.spanner.v1",
29+
package="google.spanner.v1.gapic_generated",
3030
manifest={
3131
"ResultSet",
3232
"PartialResultSet",
@@ -37,31 +37,31 @@
3737

3838

3939
class ResultSet(proto.Message):
40-
r"""Results from [Read][google.spanner.v1.Spanner.Read] or
41-
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
40+
r"""Results from [Read][google.spanner.v1.gapic_generated.Spanner.Read] or
41+
[ExecuteSql][google.spanner.v1.gapic_generated.Spanner.ExecuteSql].
4242
4343
Attributes:
4444
metadata (google.cloud.spanner_v1.types.ResultSetMetadata):
4545
Metadata about the result set, such as row
4646
type information.
4747
rows (MutableSequence[google.protobuf.struct_pb2.ListValue]):
4848
Each element in ``rows`` is a row whose format is defined by
49-
[metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type].
49+
[metadata.row_type][google.spanner.v1.gapic_generated.ResultSetMetadata.row_type].
5050
The ith element in each row matches the ith field in
51-
[metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type].
51+
[metadata.row_type][google.spanner.v1.gapic_generated.ResultSetMetadata.row_type].
5252
Elements are encoded based on type as described
53-
[here][google.spanner.v1.TypeCode].
53+
[here][google.spanner.v1.gapic_generated.TypeCode].
5454
stats (google.cloud.spanner_v1.types.ResultSetStats):
5555
Query plan and execution statistics for the SQL statement
5656
that produced this result set. These can be requested by
5757
setting
58-
[ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
58+
[ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
5959
DML statements always produce stats containing the number of
6060
rows modified, unless executed using the
61-
[ExecuteSqlRequest.QueryMode.PLAN][google.spanner.v1.ExecuteSqlRequest.QueryMode.PLAN]
62-
[ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
61+
[ExecuteSqlRequest.QueryMode.PLAN][google.spanner.v1.gapic_generated.ExecuteSqlRequest.QueryMode.PLAN]
62+
[ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
6363
Other fields may or may not be populated, based on the
64-
[ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
64+
[ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode].
6565
"""
6666

6767
metadata: "ResultSetMetadata" = proto.Field(
@@ -97,15 +97,15 @@ class PartialResultSet(proto.Message):
9797
accommodate large rows and/or large values. Every N complete
9898
values defines a row, where N is equal to the number of
9999
entries in
100-
[metadata.row_type.fields][google.spanner.v1.StructType.fields].
100+
[metadata.row_type.fields][google.spanner.v1.gapic_generated.StructType.fields].
101101
102102
Most values are encoded based on type as described
103-
[here][google.spanner.v1.TypeCode].
103+
[here][google.spanner.v1.gapic_generated.TypeCode].
104104
105105
It is possible that the last value in values is "chunked",
106106
meaning that the rest of the value is sent in subsequent
107107
``PartialResultSet``\ (s). This is denoted by the
108-
[chunked_value][google.spanner.v1.PartialResultSet.chunked_value]
108+
[chunked_value][google.spanner.v1.gapic_generated.PartialResultSet.chunked_value]
109109
field. Two or more chunked values can be merged to form a
110110
complete value as follows:
111111
@@ -175,7 +175,7 @@ class PartialResultSet(proto.Message):
175175
containing the field value ``"World" = "W" + "orl" + "d"``.
176176
chunked_value (bool):
177177
If true, then the final value in
178-
[values][google.spanner.v1.PartialResultSet.values] is
178+
[values][google.spanner.v1.gapic_generated.PartialResultSet.values] is
179179
chunked, and must be combined with more values from
180180
subsequent ``PartialResultSet``\ s to obtain a complete
181181
field value.
@@ -190,7 +190,7 @@ class PartialResultSet(proto.Message):
190190
Query plan and execution statistics for the statement that
191191
produced this streaming result set. These can be requested
192192
by setting
193-
[ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode]
193+
[ExecuteSqlRequest.query_mode][google.spanner.v1.gapic_generated.ExecuteSqlRequest.query_mode]
194194
and are sent only once with the last response in the stream.
195195
This field will also be present in the last response for DML
196196
statements.
@@ -222,8 +222,8 @@ class PartialResultSet(proto.Message):
222222

223223

224224
class ResultSetMetadata(proto.Message):
225-
r"""Metadata about a [ResultSet][google.spanner.v1.ResultSet] or
226-
[PartialResultSet][google.spanner.v1.PartialResultSet].
225+
r"""Metadata about a [ResultSet][google.spanner.v1.gapic_generated.ResultSet] or
226+
[PartialResultSet][google.spanner.v1.gapic_generated.PartialResultSet].
227227
228228
Attributes:
229229
row_type (google.cloud.spanner_v1.types.StructType):
@@ -277,8 +277,8 @@ class ResultSetMetadata(proto.Message):
277277

278278
class ResultSetStats(proto.Message):
279279
r"""Additional statistics about a
280-
[ResultSet][google.spanner.v1.ResultSet] or
281-
[PartialResultSet][google.spanner.v1.PartialResultSet].
280+
[ResultSet][google.spanner.v1.gapic_generated.ResultSet] or
281+
[PartialResultSet][google.spanner.v1.gapic_generated.PartialResultSet].
282282
283283
This message has `oneof`_ fields (mutually exclusive fields).
284284
For each oneof, at most one member field can be set at the same time.
@@ -289,7 +289,7 @@ class ResultSetStats(proto.Message):
289289
290290
Attributes:
291291
query_plan (google.cloud.spanner_v1.types.QueryPlan):
292-
[QueryPlan][google.spanner.v1.QueryPlan] for the query
292+
[QueryPlan][google.spanner.v1.gapic_generated.QueryPlan] for the query
293293
associated with this result.
294294
query_stats (google.protobuf.struct_pb2.Struct):
295295
Aggregated statistics from the execution of the query. Only

0 commit comments

Comments
 (0)