Class: Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/v2/bigtable.rb

Overview

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).

Instance Attribute Summary collapse

Instance Attribute Details

#continuation_tokens ⇒ ::Array<::Google::Cloud::Bigtable::V2::StreamContinuationToken>

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

Returns:



767
768
769
770
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 767

class CloseStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#new_partitions ⇒ ::Array<::Google::Cloud::Bigtable::V2::StreamPartition>

Returns 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.



767
768
769
770
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 767

class CloseStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#status ⇒ ::Google::Rpc::Status

Returns The status of the stream.

Returns:



767
768
769
770
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 767

class CloseStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end