Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream (v0.10.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::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).

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#continuation_tokens

def continuation_tokens() -> ::Array<::Google::Cloud::Bigtable::V2::StreamContinuationToken>
Returns

#continuation_tokens=

def continuation_tokens=(value) -> ::Array<::Google::Cloud::Bigtable::V2::StreamContinuationToken>
Parameter
Returns

#new_partitions

def new_partitions() -> ::Array<::Google::Cloud::Bigtable::V2::StreamPartition>
Returns
  • (::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.

#new_partitions=

def new_partitions=(value) -> ::Array<::Google::Cloud::Bigtable::V2::StreamPartition>
Parameter
  • value (::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.
Returns
  • (::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.

#status

def status() -> ::Google::Rpc::Status
Returns

#status=

def status=(value) -> ::Google::Rpc::Status
Parameter
Returns