Google Bigtable v2 API - Class ReadChangeStreamResponse.Types.CloseStream (3.24.0)

Reference documentation and code samples for the Google Bigtable v2 API class ReadChangeStreamResponse.Types.CloseStream.

A message indicating that the client should stop reading from the stream. If status is OK and continuation_tokens & new_partitions are empty, the stream has finished (for example if there was an end_time specified). If continuation_tokens & new_partitions are present, then a change in partitioning requires the client to open a new stream for each token to resume reading. Example:

                                 [B,      D) ends
                                      |
                                      v
              new_partitions:  [A,  C) [C,  E)
continuation_tokens.partitions:  [B,C) [C,D)
                                 ^---^ ^---^
                                 ^     ^
                                 |     |
                                 |     StreamContinuationToken 2
                                 |
                                 StreamContinuationToken 1

To read the new partition [A,C), supply the continuation tokens whose ranges cover the new partition, for example ContinuationToken[A,B) & ContinuationToken[B,C).

If non-empty, contains the information needed to resume reading their associated partitions.

If non-empty, contains the new partitions to start reading from, which are related to but not necessarily identical to the partitions for the above continuation_tokens.

The status of the stream.