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

Inherits:

Object

• Object
• Google::Cloud::Bigtable::V2::ReadChangeStreamResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/bigtable/v2/bigtable.rb

Overview

NOTE: This API is intended to be used by Apache Beam BigtableIO. Response message for Bigtable.ReadChangeStream.

Defined Under Namespace

Classes: CloseStream, DataChange, Heartbeat, MutationChunk

Instance Attribute Summary

• #close_stream ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream

  An indication that the stream should be closed.

• #data_change ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange

  A mutation to the partition.

• #heartbeat ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::Heartbeat

  A periodic heartbeat message.

Instance Attribute Details

#close_stream ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream

Returns An indication that the stream should be closed.

Returns:

• (::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::CloseStream) —

  An indication that the stream should be closed.

# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 488

class ReadChangeStreamResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A partial or complete mutation.
  # @!attribute [rw] chunk_info
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk::ChunkInfo]
  #     If set, then the mutation is a `SetCell` with a chunked value across
  #     multiple messages.
  # @!attribute [rw] mutation
  #   @return [::Google::Cloud::Bigtable::V2::Mutation]
  #     If this is a continuation of a chunked message (`chunked_value_offset` >
  #     0), ignore all fields except the `SetCell`'s value and merge it with
  #     the previous message by concatenating the value fields.
  class MutationChunk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information about the chunking of this mutation.
    # Only `SetCell` mutations can be chunked, and all chunks for a `SetCell`
    # will be delivered contiguously with no other mutation types interleaved.
    # @!attribute [rw] chunked_value_size
    #   @return [::Integer]
    #     The total value size of all the chunks that make up the `SetCell`.
    # @!attribute [rw] chunked_value_offset
    #   @return [::Integer]
    #     The byte offset of this chunk into the total value size of the
    #     mutation.
    # @!attribute [rw] last_chunk
    #   @return [::Boolean]
    #     When true, this is the last chunk of a chunked `SetCell`.
    class ChunkInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A message corresponding to one or more mutations to the partition
  # being streamed. A single logical `DataChange` message may also be split
  # across a sequence of multiple individual messages. Messages other than
  # the first in a sequence will only have the `type` and `chunks` fields
  # populated, with the final message in the sequence also containing `done`
  # set to true.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange::Type]
  #     The type of the mutation.
  # @!attribute [rw] source_cluster_id
  #   @return [::String]
  #     The cluster where the mutation was applied.
  #     Not set when `type` is `GARBAGE_COLLECTION`.
  # @!attribute [rw] row_key
  #   @return [::String]
  #     The row key for all mutations that are part of this `DataChange`.
  #     If the `DataChange` is chunked across multiple messages, then this field
  #     will only be set for the first message.
  # @!attribute [rw] commit_timestamp
  #   @return [::Google::Protobuf::Timestamp]
  #     The timestamp at which the mutation was applied on the Bigtable server.
  # @!attribute [rw] tiebreaker
  #   @return [::Integer]
  #     A value that lets stream consumers reconstruct Bigtable's
  #     conflict resolution semantics.
  #     https://cloud.google.com/bigtable/docs/writes#conflict-resolution
  #     In the event that the same row key, column family, column qualifier,
  #     timestamp are modified on different clusters at the same
  #     `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
  #     one chosen for the eventually consistent state of the system.
  # @!attribute [rw] chunks
  #   @return [::Array<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk>]
  #     The mutations associated with this change to the partition.
  #     May contain complete mutations or chunks of a multi-message chunked
  #     `DataChange` record.
  # @!attribute [rw] done
  #   @return [::Boolean]
  #     When true, indicates that the entire `DataChange` has been read
  #     and the client can safely process the message.
  # @!attribute [rw] token
  #   @return [::String]
  #     An encoded position for this stream's partition to restart reading from.
  #     This token is for the StreamPartition from the request.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class DataChange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of mutation.
    module Type
      # The type is unspecified.
      TYPE_UNSPECIFIED = 0

      # A user-initiated mutation.
      USER = 1

      # A system-initiated mutation as part of garbage collection.
      # https://cloud.google.com/bigtable/docs/garbage-collection
      GARBAGE_COLLECTION = 2

      # This is a continuation of a multi-message change.
      CONTINUATION = 3
    end
  end

  # A periodic message with information that can be used to checkpoint
  # the state of a stream.
  # @!attribute [rw] continuation_token
  #   @return [::Google::Cloud::Bigtable::V2::StreamContinuationToken]
  #     A token that can be provided to a subsequent `ReadChangeStream` call
  #     to pick up reading at the current stream position.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class Heartbeat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the stream.
  # @!attribute [rw] continuation_tokens
  #   @return [::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.
  class CloseStream
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_change ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange

Returns A mutation to the partition.

Returns:

• (::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange) —

  A mutation to the partition.

# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 488

class ReadChangeStreamResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A partial or complete mutation.
  # @!attribute [rw] chunk_info
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk::ChunkInfo]
  #     If set, then the mutation is a `SetCell` with a chunked value across
  #     multiple messages.
  # @!attribute [rw] mutation
  #   @return [::Google::Cloud::Bigtable::V2::Mutation]
  #     If this is a continuation of a chunked message (`chunked_value_offset` >
  #     0), ignore all fields except the `SetCell`'s value and merge it with
  #     the previous message by concatenating the value fields.
  class MutationChunk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information about the chunking of this mutation.
    # Only `SetCell` mutations can be chunked, and all chunks for a `SetCell`
    # will be delivered contiguously with no other mutation types interleaved.
    # @!attribute [rw] chunked_value_size
    #   @return [::Integer]
    #     The total value size of all the chunks that make up the `SetCell`.
    # @!attribute [rw] chunked_value_offset
    #   @return [::Integer]
    #     The byte offset of this chunk into the total value size of the
    #     mutation.
    # @!attribute [rw] last_chunk
    #   @return [::Boolean]
    #     When true, this is the last chunk of a chunked `SetCell`.
    class ChunkInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A message corresponding to one or more mutations to the partition
  # being streamed. A single logical `DataChange` message may also be split
  # across a sequence of multiple individual messages. Messages other than
  # the first in a sequence will only have the `type` and `chunks` fields
  # populated, with the final message in the sequence also containing `done`
  # set to true.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange::Type]
  #     The type of the mutation.
  # @!attribute [rw] source_cluster_id
  #   @return [::String]
  #     The cluster where the mutation was applied.
  #     Not set when `type` is `GARBAGE_COLLECTION`.
  # @!attribute [rw] row_key
  #   @return [::String]
  #     The row key for all mutations that are part of this `DataChange`.
  #     If the `DataChange` is chunked across multiple messages, then this field
  #     will only be set for the first message.
  # @!attribute [rw] commit_timestamp
  #   @return [::Google::Protobuf::Timestamp]
  #     The timestamp at which the mutation was applied on the Bigtable server.
  # @!attribute [rw] tiebreaker
  #   @return [::Integer]
  #     A value that lets stream consumers reconstruct Bigtable's
  #     conflict resolution semantics.
  #     https://cloud.google.com/bigtable/docs/writes#conflict-resolution
  #     In the event that the same row key, column family, column qualifier,
  #     timestamp are modified on different clusters at the same
  #     `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
  #     one chosen for the eventually consistent state of the system.
  # @!attribute [rw] chunks
  #   @return [::Array<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk>]
  #     The mutations associated with this change to the partition.
  #     May contain complete mutations or chunks of a multi-message chunked
  #     `DataChange` record.
  # @!attribute [rw] done
  #   @return [::Boolean]
  #     When true, indicates that the entire `DataChange` has been read
  #     and the client can safely process the message.
  # @!attribute [rw] token
  #   @return [::String]
  #     An encoded position for this stream's partition to restart reading from.
  #     This token is for the StreamPartition from the request.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class DataChange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of mutation.
    module Type
      # The type is unspecified.
      TYPE_UNSPECIFIED = 0

      # A user-initiated mutation.
      USER = 1

      # A system-initiated mutation as part of garbage collection.
      # https://cloud.google.com/bigtable/docs/garbage-collection
      GARBAGE_COLLECTION = 2

      # This is a continuation of a multi-message change.
      CONTINUATION = 3
    end
  end

  # A periodic message with information that can be used to checkpoint
  # the state of a stream.
  # @!attribute [rw] continuation_token
  #   @return [::Google::Cloud::Bigtable::V2::StreamContinuationToken]
  #     A token that can be provided to a subsequent `ReadChangeStream` call
  #     to pick up reading at the current stream position.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class Heartbeat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the stream.
  # @!attribute [rw] continuation_tokens
  #   @return [::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.
  class CloseStream
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#heartbeat ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::Heartbeat

Returns A periodic heartbeat message.

Returns:

• (::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::Heartbeat) —

  A periodic heartbeat message.

# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 488

class ReadChangeStreamResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A partial or complete mutation.
  # @!attribute [rw] chunk_info
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk::ChunkInfo]
  #     If set, then the mutation is a `SetCell` with a chunked value across
  #     multiple messages.
  # @!attribute [rw] mutation
  #   @return [::Google::Cloud::Bigtable::V2::Mutation]
  #     If this is a continuation of a chunked message (`chunked_value_offset` >
  #     0), ignore all fields except the `SetCell`'s value and merge it with
  #     the previous message by concatenating the value fields.
  class MutationChunk
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Information about the chunking of this mutation.
    # Only `SetCell` mutations can be chunked, and all chunks for a `SetCell`
    # will be delivered contiguously with no other mutation types interleaved.
    # @!attribute [rw] chunked_value_size
    #   @return [::Integer]
    #     The total value size of all the chunks that make up the `SetCell`.
    # @!attribute [rw] chunked_value_offset
    #   @return [::Integer]
    #     The byte offset of this chunk into the total value size of the
    #     mutation.
    # @!attribute [rw] last_chunk
    #   @return [::Boolean]
    #     When true, this is the last chunk of a chunked `SetCell`.
    class ChunkInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A message corresponding to one or more mutations to the partition
  # being streamed. A single logical `DataChange` message may also be split
  # across a sequence of multiple individual messages. Messages other than
  # the first in a sequence will only have the `type` and `chunks` fields
  # populated, with the final message in the sequence also containing `done`
  # set to true.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange::Type]
  #     The type of the mutation.
  # @!attribute [rw] source_cluster_id
  #   @return [::String]
  #     The cluster where the mutation was applied.
  #     Not set when `type` is `GARBAGE_COLLECTION`.
  # @!attribute [rw] row_key
  #   @return [::String]
  #     The row key for all mutations that are part of this `DataChange`.
  #     If the `DataChange` is chunked across multiple messages, then this field
  #     will only be set for the first message.
  # @!attribute [rw] commit_timestamp
  #   @return [::Google::Protobuf::Timestamp]
  #     The timestamp at which the mutation was applied on the Bigtable server.
  # @!attribute [rw] tiebreaker
  #   @return [::Integer]
  #     A value that lets stream consumers reconstruct Bigtable's
  #     conflict resolution semantics.
  #     https://cloud.google.com/bigtable/docs/writes#conflict-resolution
  #     In the event that the same row key, column family, column qualifier,
  #     timestamp are modified on different clusters at the same
  #     `commit_timestamp`, the mutation with the larger `tiebreaker` will be the
  #     one chosen for the eventually consistent state of the system.
  # @!attribute [rw] chunks
  #   @return [::Array<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk>]
  #     The mutations associated with this change to the partition.
  #     May contain complete mutations or chunks of a multi-message chunked
  #     `DataChange` record.
  # @!attribute [rw] done
  #   @return [::Boolean]
  #     When true, indicates that the entire `DataChange` has been read
  #     and the client can safely process the message.
  # @!attribute [rw] token
  #   @return [::String]
  #     An encoded position for this stream's partition to restart reading from.
  #     This token is for the StreamPartition from the request.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class DataChange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The type of mutation.
    module Type
      # The type is unspecified.
      TYPE_UNSPECIFIED = 0

      # A user-initiated mutation.
      USER = 1

      # A system-initiated mutation as part of garbage collection.
      # https://cloud.google.com/bigtable/docs/garbage-collection
      GARBAGE_COLLECTION = 2

      # This is a continuation of a multi-message change.
      CONTINUATION = 3
    end
  end

  # A periodic message with information that can be used to checkpoint
  # the state of a stream.
  # @!attribute [rw] continuation_token
  #   @return [::Google::Cloud::Bigtable::V2::StreamContinuationToken]
  #     A token that can be provided to a subsequent `ReadChangeStream` call
  #     to pick up reading at the current stream position.
  # @!attribute [rw] estimated_low_watermark
  #   @return [::Google::Protobuf::Timestamp]
  #     An estimate of the commit timestamp that is usually lower than or equal
  #     to any timestamp for a record that will be delivered in the future on the
  #     stream. It is possible that, under particular circumstances that a future
  #     record has a timestamp is is lower than a previously seen timestamp. For
  #     an example usage see
  #     https://beam.apache.org/documentation/basics/#watermarks
  class Heartbeat
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # 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.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the stream.
  # @!attribute [rw] continuation_tokens
  #   @return [::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.
  class CloseStream
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end