Cloud Bigtable V2 Client - Class CloseStream (1.22.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 resume reading their associated partitions.

↳ new_partitions array<Google\Cloud\Bigtable\V2\StreamPartition>

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.

getStatus

The status of the stream.

Returns
TypeDescription
Google\Rpc\Status|null

hasStatus

clearStatus

setStatus

The status of the stream.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getContinuationTokens

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setContinuationTokens

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

Parameter
NameDescription
var array<Google\Cloud\Bigtable\V2\StreamContinuationToken>
Returns
TypeDescription
$this

getNewPartitions

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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNewPartitions

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.

Parameter
NameDescription
var array<Google\Cloud\Bigtable\V2\StreamPartition>
Returns
TypeDescription
$this