Google Bigtable v2 API - Class ReadRowsResponse.Types.CellChunk (3.5.0)

public sealed class ReadRowsResponse.Types.CellChunk : IMessage<ReadRowsResponse.Types.CellChunk>, IEquatable<ReadRowsResponse.Types.CellChunk>, IDeepCloneable<ReadRowsResponse.Types.CellChunk>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Bigtable v2 API class ReadRowsResponse.Types.CellChunk.

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

Inheritance

object > ReadRowsResponse.Types.CellChunk

Implements

IMessage ReadRowsResponse Types CellChunk, IEquatable ReadRowsResponse Types CellChunk, IDeepCloneable ReadRowsResponse Types CellChunk, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

CellChunk()

public CellChunk()

CellChunk(CellChunk)

public CellChunk(ReadRowsResponse.Types.CellChunk other)

Parameter
Name	Description
`other`	`ReadRowsResponseTypesCellChunk`

Properties

CommitRow

public bool CommitRow { get; set; }

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

Property Value
Type	Description
`bool`

FamilyName

public string FamilyName { get; set; }

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.

Property Value
Type	Description
`string`

Labels

public RepeatedField<string> Labels { get; }

Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set on the first CellChunk per cell.

Property Value
Type	Description
`RepeatedFieldstring`

Qualifier

public ByteString Qualifier { get; set; }

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.

Property Value
Type	Description
`ByteString`

ResetRow

public bool ResetRow { get; set; }

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

Property Value
Type	Description
`bool`

RowKey

public ByteString RowKey { get; set; }

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.

Property Value
Type	Description
`ByteString`

RowStatusCase

public ReadRowsResponse.Types.CellChunk.RowStatusOneofCase RowStatusCase { get; }

Property Value
Type	Description
`ReadRowsResponseTypesCellChunkRowStatusOneofCase`

TimestampMicros

public long TimestampMicros { get; set; }

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).

Property Value
Type	Description
`long`

Value

public ByteString Value { get; set; }

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.

Property Value
Type	Description
`ByteString`

ValueSize

public int ValueSize { get; set; }

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.

Property Value
Type	Description
`int`