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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb

Overview

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

Defined Under Namespace

Classes: DeleteFromColumn, DeleteFromFamily, DeleteFromRow, SetCell

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Deletes cells from a column.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 419

class Mutation
  # 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; 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::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn; 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; end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow; end
end

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

Returns Deletes cells from a column family.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 419

class Mutation
  # 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; 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::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn; 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; end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow; end
end

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

Returns Deletes cells from the entire row.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 419

class Mutation
  # 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; 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::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn; 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; end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow; end
end

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

Returns Set a cell's value.

Returns:



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/data.rb', line 419

class Mutation
  # 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; 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::Bigtable::V2::TimestampRange]
  #     The range of timestamps within which cells should be deleted.
  class DeleteFromColumn; 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; end

  # A Mutation which deletes all cells from the containing row.
  class DeleteFromRow; end
end