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 collapse
-
#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.
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 |
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 584 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` & `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). # @!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 resume reading their # associated partitions. # @!attribute [rw] new_partitions # @return [::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`. 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 |
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 584 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` & `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). # @!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 resume reading their # associated partitions. # @!attribute [rw] new_partitions # @return [::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`. 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.
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 |
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 584 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` & `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). # @!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 resume reading their # associated partitions. # @!attribute [rw] new_partitions # @return [::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`. class CloseStream include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |