Class: Google::Bigtable::V2::ReadRowsResponse::CellChunk

Inherits:

Object

• Object
• Google::Bigtable::V2::ReadRowsResponse::CellChunk

Defined in:

lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb

Overview

Specifies a piece of a row's contents returned as part of the read response stream.

Instance Attribute Summary

• #commit_row ⇒ true, false

  Indicates that the client can safely process all previous chunks for +row_key+, as its data has been fully read.

• #family_name ⇒ Google::Protobuf::StringValue

  The column family name for this chunk of data.

• #labels ⇒ Array<String>

  Labels applied to the cell by a RowFilter.

• #qualifier ⇒ Google::Protobuf::BytesValue

  The column qualifier for this chunk of data.

• #reset_row ⇒ true, false

  Indicates that the client should drop all previous chunks for +row_key+, as it will be re-read from the beginning.

• #row_key ⇒ String

  The row key for this chunk of data.

• #timestamp_micros ⇒ Integer

  The cell's stored timestamp, which also uniquely identifies it within its column.

• #value ⇒ String

  The value stored in the cell.

• #value_size ⇒ Integer

  If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value.

Instance Attribute Details

#commit_row ⇒ true, false

Returns Indicates that the client can safely process all previous chunks for +row_key+, as its data has been fully read.

Returns:

• (true, false) —

  Indicates that the client can safely process all previous chunks for +row_key+, as its data has been fully read.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#family_name ⇒ Google::Protobuf::StringValue

Returns The column family name for this chunk of data. If this message is not present this CellChunk is a continuation of the same column family as the previous CellChunk. The empty string can occur as a column family name in a response so clients must check explicitly for the presence of this message, not just for +family_name.value+ being non-empty.

Returns:

• (Google::Protobuf::StringValue) —

  The column family name for this chunk of data. If this message is not present this CellChunk is a continuation of the same column family as the previous CellChunk. The empty string can occur as a column family name in a response so clients must check explicitly for the presence of this message, not just for +family_name.value+ being non-empty.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#labels ⇒ Array<String>

Returns Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.

Returns:

• (Array<String>) —

  Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#qualifier ⇒ Google::Protobuf::BytesValue

Returns The column qualifier for this chunk of data. If this message is not present, this CellChunk is a continuation of the same column as the previous CellChunk. Column qualifiers may be empty so clients must check for the presence of this message, not just for +qualifier.value+ being non-empty.

Returns:

• (Google::Protobuf::BytesValue) —

  The column qualifier for this chunk of data. If this message is not present, this CellChunk is a continuation of the same column as the previous CellChunk. Column qualifiers may be empty so clients must check for the presence of this message, not just for +qualifier.value+ being non-empty.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#reset_row ⇒ true, false

Returns Indicates that the client should drop all previous chunks for +row_key+, as it will be re-read from the beginning.

Returns:

• (true, false) —

  Indicates that the client should drop all previous chunks for +row_key+, as it will be re-read from the beginning.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#row_key ⇒ String

Returns The row key for this chunk of data. If the row key is empty, this CellChunk is a continuation of the same row as the previous CellChunk in the response stream, even if that CellChunk was in a previous ReadRowsResponse message.

Returns:

• (String) —

  The row key for this chunk of data. If the row key is empty, this CellChunk is a continuation of the same row as the previous CellChunk in the response stream, even if that CellChunk was in a previous ReadRowsResponse message.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#timestamp_micros ⇒ Integer

Returns The cell's stored timestamp, which also uniquely identifies it within its column. Values are always expressed in microseconds, but individual tables may set a coarser granularity to further restrict the allowed values. For example, a table which specifies millisecond granularity will only allow values of +timestamp_micros+ which are multiples of

1. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).

Returns:

• (Integer) —

  The cell's stored timestamp, which also uniquely identifies it within its column. Values are always expressed in microseconds, but individual tables may set a coarser granularity to further restrict the allowed values. For example, a table which specifies millisecond granularity will only allow values of +timestamp_micros+ which are multiples of

  1. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#value ⇒ String

Returns The value stored in the cell. Cell values can be split across multiple CellChunks. In that case only the value field will be set in CellChunks after the first: the timestamp and labels will only be present in the first CellChunk, even if the first CellChunk came in a previous ReadRowsResponse.

Returns:

• (String) —

  The value stored in the cell. Cell values can be split across multiple CellChunks. In that case only the value field will be set in CellChunks after the first: the timestamp and labels will only be present in the first CellChunk, even if the first CellChunk came in a previous ReadRowsResponse.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end

#value_size ⇒ Integer

Returns If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value. The client can use this size to pre-allocate memory to hold the full cell value.

Returns:

• (Integer) —

  If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value. The client can use this size to pre-allocate memory to hold the full cell value.

# File 'lib/google/cloud/bigtable/v2/doc/google/bigtable/v2/bigtable.rb', line 113

class CellChunk; end