Class: Google::Cloud::Bigtable::V2::Mutation

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

Overview

Specifies a particular change to be made to the contents of a row.

Defined Under Namespace

Classes: AddToCell, DeleteFromColumn, DeleteFromFamily, DeleteFromRow, MergeToCell, SetCell

Instance Attribute Summary collapse

Instance Attribute Details

#add_to_cell ⇒ ::Google::Cloud::Bigtable::V2::Mutation::AddToCell

Returns Incrementally updates an Aggregate cell.

Note: The following fields are mutually exclusive: add_to_cell, set_cell, merge_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::AddToCell) —

    Incrementally updates an Aggregate cell.

    Note: The following fields are mutually exclusive: add_to_cell, set_cell, merge_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_from_column ⇒ ::Google::Cloud::Bigtable::V2::Mutation::DeleteFromColumn

Returns Deletes cells from a column.

Note: The following fields are mutually exclusive: delete_from_column, set_cell, add_to_cell, merge_to_cell, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::DeleteFromColumn) —

    Deletes cells from a column.

    Note: The following fields are mutually exclusive: delete_from_column, set_cell, add_to_cell, merge_to_cell, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_from_family ⇒ ::Google::Cloud::Bigtable::V2::Mutation::DeleteFromFamily

Returns Deletes cells from a column family.

Note: The following fields are mutually exclusive: delete_from_family, set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::DeleteFromFamily) —

    Deletes cells from a column family.

    Note: The following fields are mutually exclusive: delete_from_family, set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_from_row ⇒ ::Google::Cloud::Bigtable::V2::Mutation::DeleteFromRow

Returns Deletes cells from the entire row.

Note: The following fields are mutually exclusive: delete_from_row, set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_family. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::DeleteFromRow) —

    Deletes cells from the entire row.

    Note: The following fields are mutually exclusive: delete_from_row, set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_family. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#merge_to_cell ⇒ ::Google::Cloud::Bigtable::V2::Mutation::MergeToCell

Returns Merges accumulated state to an Aggregate cell.

Note: The following fields are mutually exclusive: merge_to_cell, set_cell, add_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::MergeToCell) —

    Merges accumulated state to an Aggregate cell.

    Note: The following fields are mutually exclusive: merge_to_cell, set_cell, add_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#set_cell ⇒ ::Google::Cloud::Bigtable::V2::Mutation::SetCell

Returns Set a cell's value.

Note: The following fields are mutually exclusive: set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Bigtable::V2::Mutation::SetCell) —

    Set a cell's value.

    Note: The following fields are mutually exclusive: set_cell, add_to_cell, merge_to_cell, delete_from_column, delete_from_family, delete_from_row. If a field in that set is populated, all other fields in the set will automatically be cleared.



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
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 634

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

  # A Mutation which sets the value of the specified cell.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family into which new data should be written.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column into which new data should be written.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] timestamp_micros
  #   @return [::Integer]
  #     The timestamp of the cell into which new data should be written.
  #     Use -1 for current Bigtable server time.
  #     Otherwise, the client should set this value itself, noting that the
  #     default value is a timestamp of zero if the field is left unspecified.
  #     Values must match the granularity of the table (e.g. micros, millis).
  # @!attribute [rw] value
  #   @return [::String]
  #     The value to be written into the specified cell.
  class SetCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which incrementally updates a cell in an `Aggregate` family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be accumulated into the specified cell. This must be
  #     compatible with the family's `value_type.input_type`.
  class AddToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which merges accumulated state into a cell in an `Aggregate`
  # family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the `Aggregate` family into which new data should be added.
  #     This must be a family with a `value_type` of `Aggregate`.
  #     Format: `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The qualifier of the column into which new data should be added. This
  #     must be a `raw_value`.
  # @!attribute [rw] timestamp
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The timestamp of the cell to which new data should be added. This must
  #     be a `raw_timestamp_micros` that matches the table's `granularity`.
  # @!attribute [rw] input
  #   @return [::Google::Cloud::Bigtable::V2::Value]
  #     The input value to be merged into the specified cell. This must be
  #     compatible with the family's `value_type.state_type`. Merging `NULL` is
  #     allowed, but has no effect.
  class MergeToCell
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes cells from the specified column, optionally
  # restricting the deletions to a given timestamp range.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  # @!attribute [rw] column_qualifier
  #   @return [::String]
  #     The qualifier of the column from which cells should be deleted.
  #     Can be any byte string, including the empty string.
  # @!attribute [rw] time_range
  #   @return [::Google::Cloud::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the specified column family.
  # @!attribute [rw] family_name
  #   @return [::String]
  #     The name of the family from which cells should be deleted.
  #     Must match `[-_.a-zA-Z0-9]+`
  class DeleteFromFamily
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end