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 is empty, the stream has finished
(for example if there was an end_time specified).
If continuation_tokens is present, then a change in partitioning requires
the client to open a new stream for each token to resume reading.
Generated from protobuf message google.bigtable.v2.ReadChangeStreamResponse.CloseStream
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ status |
Google\Rpc\Status
The status of the stream. |
↳ continuation_tokens |
array<Google\Cloud\Bigtable\V2\StreamContinuationToken>
If non-empty, contains the information needed to start reading the new partition(s) that contain segments of this partition's row range. |
getStatus
The status of the stream.
| Returns | |
|---|---|
| Type | Description |
Google\Rpc\Status|null | |
hasStatus
clearStatus
setStatus
The status of the stream.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Rpc\Status
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContinuationTokens
If non-empty, contains the information needed to start reading the new partition(s) that contain segments of this partition's row range.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setContinuationTokens
If non-empty, contains the information needed to start reading the new partition(s) that contain segments of this partition's row range.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Bigtable\V2\StreamContinuationToken>
|
| Returns | |
|---|---|
| Type | Description |
$this | |