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

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

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#chunks ⇒ ::Array<::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::MutationChunk>

Returns The mutations associated with this change to the partition. May contain complete mutations or chunks of a multi-message chunked DataChange record.

Returns:



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#commit_timestamp ⇒ ::Google::Protobuf::Timestamp

Returns The timestamp at which the mutation was applied on the Bigtable server.

Returns:



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#done ⇒ ::Boolean

Returns When true, indicates that the entire DataChange has been read and the client can safely process the message.

Returns:

  • (::Boolean) —

    When true, indicates that the entire DataChange has been read and the client can safely process the message.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#estimated_low_watermark ⇒ ::Google::Protobuf::Timestamp

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

Returns:



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#row_key ⇒ ::String

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

Returns:

  • (::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.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#source_cluster_id ⇒ ::String

Returns The cluster where the mutation was applied. Not set when type is GARBAGE_COLLECTION.

Returns:

  • (::String) —

    The cluster where the mutation was applied. Not set when type is GARBAGE_COLLECTION.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#tiebreaker ⇒ ::Integer

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

Returns:

  • (::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.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#token ⇒ ::String

Returns An encoded position for this stream's partition to restart reading from. This token is for the StreamPartition from the request.

Returns:

  • (::String) —

    An encoded position for this stream's partition to restart reading from. This token is for the StreamPartition from the request.



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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

#type ⇒ ::Google::Cloud::Bigtable::V2::ReadChangeStreamResponse::DataChange::Type

Returns The type of the mutation.

Returns:



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 576

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