Reference documentation and code samples for the Cloud Bigtable V2 Client class CellChunk.
Specifies a piece of a row's contents returned as part of the read response stream.
Generated from protobuf message google.bigtable.v2.ReadRowsResponse.CellChunk
Namespace
Google \ Cloud \ Bigtable \ V2 \ ReadRowsResponseMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ row_key
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.
↳ family_name
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.
↳ qualifier
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.
↳ timestamp_micros
int|string
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 1000. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).
↳ labels
array
Labels applied to the cell by a RowFilter . Labels are only set on the first CellChunk per cell.
↳ 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.
↳ value_size
int
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.
↳ reset_row
bool
Indicates that the client should drop all previous chunks for row_key
, as it will be re-read from the beginning.
↳ commit_row
bool
Indicates that the client can safely process all previous chunks for row_key
, as its data has been fully read.
getRowKey
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.
string
setRowKey
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.
var
string
$this
getFamilyName
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.
hasFamilyName
clearFamilyName
getFamilyNameValue
Returns the unboxed value from getFamilyName()
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.
string|null
setFamilyName
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.
$this
setFamilyNameValue
Sets the field by wrapping a primitive type in a Google\Protobuf\StringValue object.
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.
var
string|null
$this
getQualifier
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.
hasQualifier
clearQualifier
getQualifierValue
Returns the unboxed value from getQualifier()
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.
string|null
setQualifier
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.
$this
setQualifierValue
Sets the field by wrapping a primitive type in a Google\Protobuf\BytesValue object.
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.
var
string|null
$this
getTimestampMicros
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
- Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).
int|string
setTimestampMicros
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
- Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks).
var
int|string
$this
getLabels
Labels applied to the cell by a RowFilter . Labels are only set on the first CellChunk per cell.
setLabels
Labels applied to the cell by a RowFilter . Labels are only set on the first CellChunk per cell.
var
string[]
$this
getValue
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.
string
setValue
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.
var
string
$this
getValueSize
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.
int
setValueSize
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.
var
int
$this
getResetRow
Indicates that the client should drop all previous chunks for row_key
, as it will be re-read from the beginning.
bool
hasResetRow
setResetRow
Indicates that the client should drop all previous chunks for row_key
, as it will be re-read from the beginning.
var
bool
$this
getCommitRow
Indicates that the client can safely process all previous chunks for row_key
, as its data has been fully read.
bool
hasCommitRow
setCommitRow
Indicates that the client can safely process all previous chunks for row_key
, as its data has been fully read.
var
bool
$this
getRowStatus
string
