Skip to content

Commit 70edda4

Browse files
1 parent 5e5dc6c commit 70edda4

File tree

131 files changed

+123
-123348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+123
-123348
lines changed

β€Žgoogle/cloud/bigtable_v2/services/bigtable/async_client.pyβ€Ž

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1164,7 +1164,9 @@ async def read_modify_write_row(
11641164
transformed into writes. Entries are
11651165
applied in order, meaning that earlier
11661166
rules will affect the results of later
1167-
ones.
1167+
ones. At least one entry must be
1168+
specified, and there can be at most
1169+
100000 rules.
11681170
11691171
This corresponds to the ``rules`` field
11701172
on the ``request`` instance; if ``request`` is provided, this
@@ -1281,10 +1283,11 @@ def generate_initial_change_stream_partitions(
12811283
) -> Awaitable[
12821284
AsyncIterable[bigtable.GenerateInitialChangeStreamPartitionsResponse]
12831285
]:
1284-
r"""NOTE: This API is intended to be used by Apache Beam BigtableIO.
1285-
Returns the current list of partitions that make up the table's
1286+
r"""Returns the current list of partitions that make up the table's
12861287
change stream. The union of partitions will cover the entire
12871288
keyspace. Partitions can be read with ``ReadChangeStream``.
1289+
NOTE: This API is only intended to be used by Apache Beam
1290+
BigtableIO.
12881291
12891292
Args:
12901293
request (Optional[Union[google.cloud.bigtable_v2.types.GenerateInitialChangeStreamPartitionsRequest, dict]]):
@@ -1392,10 +1395,11 @@ def read_change_stream(
13921395
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
13931396
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
13941397
) -> Awaitable[AsyncIterable[bigtable.ReadChangeStreamResponse]]:
1395-
r"""NOTE: This API is intended to be used by Apache Beam
1396-
BigtableIO. Reads changes from a table's change stream.
1397-
Changes will reflect both user-initiated mutations and
1398-
mutations that are caused by garbage collection.
1398+
r"""Reads changes from a table's change stream. Changes
1399+
will reflect both user-initiated mutations and mutations
1400+
that are caused by garbage collection.
1401+
NOTE: This API is only intended to be used by Apache
1402+
Beam BigtableIO.
13991403
14001404
Args:
14011405
request (Optional[Union[google.cloud.bigtable_v2.types.ReadChangeStreamRequest, dict]]):

β€Žgoogle/cloud/bigtable_v2/services/bigtable/client.pyβ€Ž

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1625,7 +1625,9 @@ def read_modify_write_row(
16251625
transformed into writes. Entries are
16261626
applied in order, meaning that earlier
16271627
rules will affect the results of later
1628-
ones.
1628+
ones. At least one entry must be
1629+
specified, and there can be at most
1630+
100000 rules.
16291631
16301632
This corresponds to the ``rules`` field
16311633
on the ``request`` instance; if ``request`` is provided, this
@@ -1737,10 +1739,11 @@ def generate_initial_change_stream_partitions(
17371739
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
17381740
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
17391741
) -> Iterable[bigtable.GenerateInitialChangeStreamPartitionsResponse]:
1740-
r"""NOTE: This API is intended to be used by Apache Beam BigtableIO.
1741-
Returns the current list of partitions that make up the table's
1742+
r"""Returns the current list of partitions that make up the table's
17421743
change stream. The union of partitions will cover the entire
17431744
keyspace. Partitions can be read with ``ReadChangeStream``.
1745+
NOTE: This API is only intended to be used by Apache Beam
1746+
BigtableIO.
17441747
17451748
Args:
17461749
request (Union[google.cloud.bigtable_v2.types.GenerateInitialChangeStreamPartitionsRequest, dict]):
@@ -1847,10 +1850,11 @@ def read_change_stream(
18471850
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
18481851
metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
18491852
) -> Iterable[bigtable.ReadChangeStreamResponse]:
1850-
r"""NOTE: This API is intended to be used by Apache Beam
1851-
BigtableIO. Reads changes from a table's change stream.
1852-
Changes will reflect both user-initiated mutations and
1853-
mutations that are caused by garbage collection.
1853+
r"""Reads changes from a table's change stream. Changes
1854+
will reflect both user-initiated mutations and mutations
1855+
that are caused by garbage collection.
1856+
NOTE: This API is only intended to be used by Apache
1857+
Beam BigtableIO.
18541858
18551859
Args:
18561860
request (Union[google.cloud.bigtable_v2.types.ReadChangeStreamRequest, dict]):

β€Žgoogle/cloud/bigtable_v2/services/bigtable/transports/grpc.pyβ€Ž

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -538,10 +538,11 @@ def generate_initial_change_stream_partitions(
538538
r"""Return a callable for the generate initial change stream
539539
partitions method over gRPC.
540540
541-
NOTE: This API is intended to be used by Apache Beam BigtableIO.
542541
Returns the current list of partitions that make up the table's
543542
change stream. The union of partitions will cover the entire
544543
keyspace. Partitions can be read with ``ReadChangeStream``.
544+
NOTE: This API is only intended to be used by Apache Beam
545+
BigtableIO.
545546
546547
Returns:
547548
Callable[[~.GenerateInitialChangeStreamPartitionsRequest],
@@ -571,10 +572,11 @@ def read_change_stream(
571572
]:
572573
r"""Return a callable for the read change stream method over gRPC.
573574
574-
NOTE: This API is intended to be used by Apache Beam
575-
BigtableIO. Reads changes from a table's change stream.
576-
Changes will reflect both user-initiated mutations and
577-
mutations that are caused by garbage collection.
575+
Reads changes from a table's change stream. Changes
576+
will reflect both user-initiated mutations and mutations
577+
that are caused by garbage collection.
578+
NOTE: This API is only intended to be used by Apache
579+
Beam BigtableIO.
578580
579581
Returns:
580582
Callable[[~.ReadChangeStreamRequest],

β€Žgoogle/cloud/bigtable_v2/services/bigtable/transports/grpc_asyncio.pyβ€Ž

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -552,10 +552,11 @@ def generate_initial_change_stream_partitions(
552552
r"""Return a callable for the generate initial change stream
553553
partitions method over gRPC.
554554
555-
NOTE: This API is intended to be used by Apache Beam BigtableIO.
556555
Returns the current list of partitions that make up the table's
557556
change stream. The union of partitions will cover the entire
558557
keyspace. Partitions can be read with ``ReadChangeStream``.
558+
NOTE: This API is only intended to be used by Apache Beam
559+
BigtableIO.
559560
560561
Returns:
561562
Callable[[~.GenerateInitialChangeStreamPartitionsRequest],
@@ -585,10 +586,11 @@ def read_change_stream(
585586
]:
586587
r"""Return a callable for the read change stream method over gRPC.
587588
588-
NOTE: This API is intended to be used by Apache Beam
589-
BigtableIO. Reads changes from a table's change stream.
590-
Changes will reflect both user-initiated mutations and
591-
mutations that are caused by garbage collection.
589+
Reads changes from a table's change stream. Changes
590+
will reflect both user-initiated mutations and mutations
591+
that are caused by garbage collection.
592+
NOTE: This API is only intended to be used by Apache
593+
Beam BigtableIO.
592594
593595
Returns:
594596
Callable[[~.ReadChangeStreamRequest],

β€Žgoogle/cloud/bigtable_v2/types/bigtable.pyβ€Ž

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -197,27 +197,12 @@ class ReadRowsResponse(proto.Message):
197197
row key, allowing the client to skip that work
198198
on a retry.
199199
request_stats (google.cloud.bigtable_v2.types.RequestStats):
200-
If requested, provide enhanced query performance statistics.
201-
The semantics dictate:
202-
203-
- request_stats is empty on every (streamed) response,
204-
except
205-
- request_stats has non-empty information after all chunks
206-
have been streamed, where the ReadRowsResponse message
207-
only contains request_stats.
208-
209-
- For example, if a read request would have returned an
210-
empty response instead a single ReadRowsResponse is
211-
streamed with empty chunks and request_stats filled.
212-
213-
Visually, response messages will stream as follows: ... ->
214-
{chunks: [...]} -> {chunks: [], request_stats: {...}}
215-
\_\ **/ \_**\ \__________/ Primary response Trailer of
216-
RequestStats info
217-
218-
Or if the read did not return any values: {chunks: [],
219-
request_stats: {...}} \________________________________/
220-
Trailer of RequestStats info
200+
If requested, return enhanced query performance statistics.
201+
The field request_stats is empty in a streamed response
202+
unless the ReadRowsResponse message contains request_stats
203+
in the last message of the stream. Always returned when
204+
requested, even when the read request returns an empty
205+
response.
221206
"""
222207

223208
class CellChunk(proto.Message):
@@ -649,8 +634,8 @@ class RateLimitInfo(proto.Message):
649634
``factor`` until another ``period`` has passed.
650635
651636
The client can measure its load using any unit that's
652-
comparable over time For example, QPS can be used as long as
653-
each request involves a similar amount of work.
637+
comparable over time. For example, QPS can be used as long
638+
as each request involves a similar amount of work.
654639
"""
655640

656641
period: duration_pb2.Duration = proto.Field(
@@ -816,7 +801,9 @@ class ReadModifyWriteRowRequest(proto.Message):
816801
row's contents are to be transformed into
817802
writes. Entries are applied in order, meaning
818803
that earlier rules will affect the results of
819-
later ones.
804+
later ones. At least one entry must be
805+
specified, and there can be at most 100000
806+
rules.
820807
"""
821808

822809
table_name: str = proto.Field(
@@ -944,10 +931,10 @@ class ReadChangeStreamRequest(proto.Message):
944931
the stream as part of ``Heartbeat`` and ``CloseStream``
945932
messages.
946933
947-
If a single token is provided, the token’s partition must
948-
exactly match the request’s partition. If multiple tokens
934+
If a single token is provided, the token's partition must
935+
exactly match the request's partition. If multiple tokens
949936
are provided, as in the case of a partition merge, the union
950-
of the token partitions must exactly cover the request’s
937+
of the token partitions must exactly cover the request's
951938
partition. Otherwise, INVALID_ARGUMENT will be returned.
952939
953940
This field is a member of `oneof`_ ``start_from``.
@@ -1128,7 +1115,7 @@ class DataChange(proto.Message):
11281115
a record that will be delivered in the future on
11291116
the stream. It is possible that, under
11301117
particular circumstances that a future record
1131-
has a timestamp is is lower than a previously
1118+
has a timestamp that is lower than a previously
11321119
seen timestamp. For an example usage see
11331120
https://beam.apache.org/documentation/basics/#watermarks
11341121
"""
@@ -1212,7 +1199,7 @@ class Heartbeat(proto.Message):
12121199
a record that will be delivered in the future on
12131200
the stream. It is possible that, under
12141201
particular circumstances that a future record
1215-
has a timestamp is is lower than a previously
1202+
has a timestamp that is lower than a previously
12161203
seen timestamp. For an example usage see
12171204
https://beam.apache.org/documentation/basics/#watermarks
12181205
"""
@@ -1235,12 +1222,25 @@ class CloseStream(proto.Message):
12351222
if there was an ``end_time`` specified). If ``continuation_tokens``
12361223
& ``new_partitions`` are present, then a change in partitioning
12371224
requires the client to open a new stream for each token to resume
1238-
reading. Example: [B, D) ends \| v new_partitions: [A, C) [C, E)
1239-
continuation_tokens.partitions: [B,C) [C,D) ^---^ ^---^ ^ ^ \| \| \|
1240-
StreamContinuationToken 2 \| StreamContinuationToken 1 To read the
1241-
new partition [A,C), supply the continuation tokens whose ranges
1242-
cover the new partition, for example ContinuationToken[A,B) &
1243-
ContinuationToken[B,C).
1225+
reading. Example:
1226+
1227+
::
1228+
1229+
[B, D) ends
1230+
|
1231+
v
1232+
new_partitions: [A, C) [C, E)
1233+
continuation_tokens.partitions: [B,C) [C,D)
1234+
^---^ ^---^
1235+
^ ^
1236+
| |
1237+
| StreamContinuationToken 2
1238+
|
1239+
StreamContinuationToken 1
1240+
1241+
To read the new partition [A,C), supply the continuation tokens
1242+
whose ranges cover the new partition, for example
1243+
ContinuationToken[A,B) & ContinuationToken[B,C).
12441244
12451245
Attributes:
12461246
status (google.rpc.status_pb2.Status):

β€Žgoogle/cloud/bigtable_v2/types/data.pyβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,8 @@ class Value(proto.Message):
241241
This field is a member of `oneof`_ ``kind``.
242242
float_value (float):
243243
Represents a typed value transported as a
244-
floating point number.
244+
floating point number. Does not support NaN or
245+
infinities.
245246
246247
This field is a member of `oneof`_ ``kind``.
247248
timestamp_value (google.protobuf.timestamp_pb2.Timestamp):

β€Žgoogle/cloud/bigtable_v2/types/request_stats.pyβ€Ž

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,10 @@ class FullReadStatsView(proto.Message):
142142

143143

144144
class RequestStats(proto.Message):
145-
r"""RequestStats is the container for additional information pertaining
146-
to a single request, helpful for evaluating the performance of the
147-
sent request. Currently, there are the following supported methods:
148-
149-
- google.bigtable.v2.ReadRows
145+
r"""RequestStats is the container for additional information
146+
pertaining to a single request, helpful for evaluating the
147+
performance of the sent request. Currently, the following method
148+
is supported: google.bigtable.v2.ReadRows
150149
151150
152151
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

β€Žgoogle/cloud/bigtable_v2/types/response_params.pyβ€Ž

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,7 @@
2929

3030

3131
class ResponseParams(proto.Message):
32-
r"""Response metadata proto This is an experimental feature that will be
33-
used to get zone_id and cluster_id from response trailers to tag the
34-
metrics. This should not be used by customers directly
35-
32+
r"""Response metadata proto
3633
3734
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
3835

β€Žowl-bot-staging/bigtable/v2/.coveragercβ€Ž

Lines changed: 0 additions & 13 deletions
This file was deleted.

β€Žowl-bot-staging/bigtable/v2/.flake8β€Ž

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
Β (0)