Class ReadRowsResponse.CellChunk (2.17.0)

public static final class ReadRowsResponse.CellChunk extends GeneratedMessageV3 implements ReadRowsResponse.CellChunkOrBuilder

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

Protobuf type google.bigtable.v2.ReadRowsResponse.CellChunk

Static Fields

COMMIT_ROW_FIELD_NUMBER

public static final int COMMIT_ROW_FIELD_NUMBER
Field Value
TypeDescription
int

FAMILY_NAME_FIELD_NUMBER

public static final int FAMILY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

QUALIFIER_FIELD_NUMBER

public static final int QUALIFIER_FIELD_NUMBER
Field Value
TypeDescription
int

RESET_ROW_FIELD_NUMBER

public static final int RESET_ROW_FIELD_NUMBER
Field Value
TypeDescription
int

ROW_KEY_FIELD_NUMBER

public static final int ROW_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

TIMESTAMP_MICROS_FIELD_NUMBER

public static final int TIMESTAMP_MICROS_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_SIZE_FIELD_NUMBER

public static final int VALUE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadRowsResponse.CellChunk getDefaultInstance()
Returns
TypeDescription
ReadRowsResponse.CellChunk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadRowsResponse.CellChunk.Builder newBuilder()
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

newBuilder(ReadRowsResponse.CellChunk prototype)

public static ReadRowsResponse.CellChunk.Builder newBuilder(ReadRowsResponse.CellChunk prototype)
Parameter
NameDescription
prototypeReadRowsResponse.CellChunk
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

parseDelimitedFrom(InputStream input)

public static ReadRowsResponse.CellChunk parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadRowsResponse.CellChunk parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadRowsResponse.CellChunk parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadRowsResponse.CellChunk parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadRowsResponse.CellChunk parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadRowsResponse.CellChunk parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsResponse.CellChunk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadRowsResponse.CellChunk> parser()
Returns
TypeDescription
Parser<CellChunk>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCommitRow()

public boolean getCommitRow()

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

bool commit_row = 9;

Returns
TypeDescription
boolean

The commitRow.

getDefaultInstanceForType()

public ReadRowsResponse.CellChunk getDefaultInstanceForType()
Returns
TypeDescription
ReadRowsResponse.CellChunk

getFamilyName()

public StringValue 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.

.google.protobuf.StringValue family_name = 2;

Returns
TypeDescription
StringValue

The familyName.

getFamilyNameOrBuilder()

public StringValueOrBuilder getFamilyNameOrBuilder()

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.

.google.protobuf.StringValue family_name = 2;

Returns
TypeDescription
StringValueOrBuilder

getLabels(int index)

public String getLabels(int index)

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

repeated string labels = 5;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The labels at the given index.

getLabelsBytes(int index)

public ByteString getLabelsBytes(int index)

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

repeated string labels = 5;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the labels at the given index.

getLabelsCount()

public int getLabelsCount()

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

repeated string labels = 5;

Returns
TypeDescription
int

The count of labels.

getLabelsList()

public ProtocolStringList getLabelsList()

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

repeated string labels = 5;

Returns
TypeDescription
ProtocolStringList

A list containing the labels.

getParserForType()

public Parser<ReadRowsResponse.CellChunk> getParserForType()
Returns
TypeDescription
Parser<CellChunk>
Overrides

getQualifier()

public BytesValue 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.

.google.protobuf.BytesValue qualifier = 3;

Returns
TypeDescription
BytesValue

The qualifier.

getQualifierOrBuilder()

public BytesValueOrBuilder getQualifierOrBuilder()

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.

.google.protobuf.BytesValue qualifier = 3;

Returns
TypeDescription
BytesValueOrBuilder

getResetRow()

public boolean getResetRow()

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

bool reset_row = 8;

Returns
TypeDescription
boolean

The resetRow.

getRowKey()

public ByteString 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.

bytes row_key = 1;

Returns
TypeDescription
ByteString

The rowKey.

getRowStatusCase()

public ReadRowsResponse.CellChunk.RowStatusCase getRowStatusCase()
Returns
TypeDescription
ReadRowsResponse.CellChunk.RowStatusCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimestampMicros()

public long 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

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

int64 timestamp_micros = 4;

Returns
TypeDescription
long

The timestampMicros.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValue()

public ByteString 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.

bytes value = 6;

Returns
TypeDescription
ByteString

The value.

getValueSize()

public int 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.

int32 value_size = 7;

Returns
TypeDescription
int

The valueSize.

hasCommitRow()

public boolean hasCommitRow()

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

bool commit_row = 9;

Returns
TypeDescription
boolean

Whether the commitRow field is set.

hasFamilyName()

public boolean hasFamilyName()

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.

.google.protobuf.StringValue family_name = 2;

Returns
TypeDescription
boolean

Whether the familyName field is set.

hasQualifier()

public boolean hasQualifier()

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.

.google.protobuf.BytesValue qualifier = 3;

Returns
TypeDescription
boolean

Whether the qualifier field is set.

hasResetRow()

public boolean hasResetRow()

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

bool reset_row = 8;

Returns
TypeDescription
boolean

Whether the resetRow field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadRowsResponse.CellChunk.Builder newBuilderForType()
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadRowsResponse.CellChunk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadRowsResponse.CellChunk.Builder toBuilder()
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException