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, SetCell

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Incrementally updates an Aggregate cell.

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 488

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

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 488

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

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 488

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

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 488

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

Returns:



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'proto_docs/google/bigtable/v2/data.rb', line 488

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