Reference documentation and code samples for the Cloud Bigtable V2 Client class 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).
Generated from protobuf message google.bigtable.v2.ReadChangeStreamResponse.CloseStream
Namespace
Google \ Cloud \ Bigtable \ V2 \ ReadChangeStreamResponse
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class CloseStream (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.ReadChangeStreamResponse.CloseStream)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.ReadChangeStreamResponse.CloseStream)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.ReadChangeStreamResponse.CloseStream)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.ReadChangeStreamResponse.CloseStream)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.ReadChangeStreamResponse.CloseStream)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.ReadChangeStreamResponse.CloseStream)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.ReadChangeStreamResponse.CloseStream)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.ReadChangeStreamResponse.CloseStream)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.ReadChangeStreamResponse.CloseStream)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.ReadChangeStreamResponse.CloseStream)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.ReadChangeStreamResponse.CloseStream)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.ReadChangeStreamResponse.CloseStream)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.ReadChangeStreamResponse.CloseStream)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.ReadChangeStreamResponse.CloseStream)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.ReadChangeStreamResponse.CloseStream)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.ReadChangeStreamResponse.CloseStream)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.ReadChangeStreamResponse.CloseStream)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.ReadChangeStreamResponse.CloseStream)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.ReadChangeStreamResponse.CloseStream)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.ReadChangeStreamResponse.CloseStream) \nReference documentation and code samples for the Cloud Bigtable V2 Client class CloseStream.\n\nA message indicating that the client should stop reading from the stream.\n\nIf status is OK and `continuation_tokens` \\& `new_partitions` are empty, the\nstream has finished (for example if there was an `end_time` specified).\nIf `continuation_tokens` \\& `new_partitions` are present, then a change in\npartitioning requires the client to open a new stream for each token to\nresume reading. Example:\n\\[B, D) ends\n\\|\nv\nnew_partitions: \\[A, C) \\[C, E)\ncontinuation_tokens.partitions: \\[B,C) \\[C,D)\n\\^---\\^ \\^---\\^\n\\^ \\^\n\\| \\|\n\\| StreamContinuationToken 2\n\\|\nStreamContinuationToken 1\nTo read the new partition \\[A,C), supply the continuation tokens whose\nranges cover the new partition, for example ContinuationToken\\[A,B) \\&\nContinuationToken\\[B,C).\n\nGenerated from protobuf message `google.bigtable.v2.ReadChangeStreamResponse.CloseStream`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2 \\\\ ReadChangeStreamResponse\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getStatus\n\nThe status of the stream.\n\n### hasStatus\n\n### clearStatus\n\n### setStatus\n\nThe status of the stream.\n\n### getContinuationTokens\n\nIf non-empty, contains the information needed to resume reading their\nassociated partitions.\n\n### setContinuationTokens\n\nIf non-empty, contains the information needed to resume reading their\nassociated partitions.\n\n### getNewPartitions\n\nIf non-empty, contains the new partitions to start reading from, which\nare related to but not necessarily identical to the partitions for the\nabove `continuation_tokens`.\n\n### setNewPartitions\n\nIf non-empty, contains the new partitions to start reading from, which\nare related to but not necessarily identical to the partitions for the\nabove `continuation_tokens`."]]