Class Google::Cloud::Bigtable::V2::ReadRowsResponse::CellChunk (v0.4.0)

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#commit_row

def commit_row() -> ::Boolean
Returns
  • (::Boolean) — Indicates that the client can safely process all previous chunks for row_key, as its data has been fully read.

#commit_row=

def commit_row=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates that the client can safely process all previous chunks for row_key, as its data has been fully read.
Returns
  • (::Boolean) — Indicates that the client can safely process all previous chunks for row_key, as its data has been fully read.

#family_name

def family_name() -> ::Google::Protobuf::StringValue
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.

#family_name=

def family_name=(value) -> ::Google::Protobuf::StringValue
Parameter
  • value (::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.
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.

#labels

def labels() -> ::Array<::String>
Returns
  • (::Array<::String>) — Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.

#labels=

def labels=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

#qualifier

def qualifier() -> ::Google::Protobuf::BytesValue
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.

#qualifier=

def qualifier=(value) -> ::Google::Protobuf::BytesValue
Parameter
  • value (::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.
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.

#reset_row

def reset_row() -> ::Boolean
Returns
  • (::Boolean) — Indicates that the client should drop all previous chunks for row_key, as it will be re-read from the beginning.

#reset_row=

def reset_row=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates that the client should drop all previous chunks for row_key, as it will be re-read from the beginning.
Returns
  • (::Boolean) — Indicates that the client should drop all previous chunks for row_key, as it will be re-read from the beginning.

#row_key

def row_key() -> ::String
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.

#row_key=

def row_key=(value) -> ::String
Parameter
  • value (::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.
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.

#timestamp_micros

def timestamp_micros() -> ::Integer
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).

#timestamp_micros=

def timestamp_micros=(value) -> ::Integer
Parameter
  • value (::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).
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).

#value

def value() -> ::String
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.

#value=

def value=(value) -> ::String
Parameter
  • value (::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.
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.

#value_size

def value_size() -> ::Integer
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.

#value_size=

def value_size=(value) -> ::Integer
Parameter
  • value (::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.
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.