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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
↳ 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 |
↳ 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 |
↳ commit_row |
bool
Indicates that the client can safely process all previous chunks for |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\StringValue|null | |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\StringValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\BytesValue|null | |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\BytesValue
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Parameter | |
|---|---|
| Name | Description |
var |
string|null
|
| Returns | |
|---|---|
| Type | Description |
$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).
| Returns | |
|---|---|
| Type | Description |
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).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setLabels
Labels applied to the cell by a RowFilter. Labels are only set on the first CellChunk per cell.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResetRow
Indicates that the client should drop all previous chunks for
row_key, as it will be re-read from the beginning.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasResetRow
setResetRow
Indicates that the client should drop all previous chunks for
row_key, as it will be re-read from the beginning.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCommitRow
Indicates that the client can safely process all previous chunks for
row_key, as its data has been fully read.
| Returns | |
|---|---|
| Type | Description |
bool | |
hasCommitRow
setCommitRow
Indicates that the client can safely process all previous chunks for
row_key, as its data has been fully read.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowStatus
| Returns | |
|---|---|
| Type | Description |
string | |