Class ReadRowsResponse.CellChunk.Builder (2.3.1)

public static final class ReadRowsResponse.CellChunk.Builder extends GeneratedMessageV3.Builder<ReadRowsResponse.CellChunk.Builder> 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

Methods

addAllLabels(Iterable<String> values)

public ReadRowsResponse.CellChunk.Builder addAllLabels(Iterable<String> values)

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

repeated string labels = 5;

Parameter
NameDescription
valuesIterable<String>

The labels to add.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

addLabels(String value)

public ReadRowsResponse.CellChunk.Builder addLabels(String value)

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

repeated string labels = 5;

Parameter
NameDescription
valueString

The labels to add.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

addLabelsBytes(ByteString value)

public ReadRowsResponse.CellChunk.Builder addLabelsBytes(ByteString value)

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

repeated string labels = 5;

Parameter
NameDescription
valueByteString

The bytes of the labels to add.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsResponse.CellChunk.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ReadRowsResponse.CellChunk.Builder clear()
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

clearCommitRow()

public ReadRowsResponse.CellChunk.Builder clearCommitRow()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearFamilyName()

public ReadRowsResponse.CellChunk.Builder clearFamilyName()

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
ReadRowsResponse.CellChunk.Builder

clearField(Descriptors.FieldDescriptor field)

public ReadRowsResponse.CellChunk.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

clearLabels()

public ReadRowsResponse.CellChunk.Builder clearLabels()

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

repeated string labels = 5;

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadRowsResponse.CellChunk.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

clearQualifier()

public ReadRowsResponse.CellChunk.Builder clearQualifier()

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
ReadRowsResponse.CellChunk.Builder

clearResetRow()

public ReadRowsResponse.CellChunk.Builder clearResetRow()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearRowKey()

public ReadRowsResponse.CellChunk.Builder clearRowKey()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearRowStatus()

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

clearTimestampMicros()

public ReadRowsResponse.CellChunk.Builder clearTimestampMicros()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearValue()

public ReadRowsResponse.CellChunk.Builder clearValue()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clearValueSize()

public ReadRowsResponse.CellChunk.Builder clearValueSize()

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
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

clone()

public ReadRowsResponse.CellChunk.Builder clone()
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
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

getDescriptor()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getFamilyNameBuilder()

public StringValue.Builder getFamilyNameBuilder()

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
Builder

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.

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.

getQualifierBuilder()

public BytesValue.Builder getQualifierBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFamilyName(StringValue value)

public ReadRowsResponse.CellChunk.Builder mergeFamilyName(StringValue value)

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;

Parameter
NameDescription
valueStringValue
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

mergeFrom(ReadRowsResponse.CellChunk other)

public ReadRowsResponse.CellChunk.Builder mergeFrom(ReadRowsResponse.CellChunk other)
Parameter
NameDescription
otherReadRowsResponse.CellChunk
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadRowsResponse.CellChunk.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ReadRowsResponse.CellChunk.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

mergeQualifier(BytesValue value)

public ReadRowsResponse.CellChunk.Builder mergeQualifier(BytesValue value)

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;

Parameter
NameDescription
valueBytesValue
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsResponse.CellChunk.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

setCommitRow(boolean value)

public ReadRowsResponse.CellChunk.Builder setCommitRow(boolean value)

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

bool commit_row = 9;

Parameter
NameDescription
valueboolean

The commitRow to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setFamilyName(StringValue value)

public ReadRowsResponse.CellChunk.Builder setFamilyName(StringValue value)

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;

Parameter
NameDescription
valueStringValue
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

setFamilyName(StringValue.Builder builderForValue)

public ReadRowsResponse.CellChunk.Builder setFamilyName(StringValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsResponse.CellChunk.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

setLabels(int index, String value)

public ReadRowsResponse.CellChunk.Builder setLabels(int index, String value)

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

repeated string labels = 5;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The labels to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setQualifier(BytesValue value)

public ReadRowsResponse.CellChunk.Builder setQualifier(BytesValue value)

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;

Parameter
NameDescription
valueBytesValue
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

setQualifier(BytesValue.Builder builderForValue)

public ReadRowsResponse.CellChunk.Builder setQualifier(BytesValue.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReadRowsResponse.CellChunk.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

setResetRow(boolean value)

public ReadRowsResponse.CellChunk.Builder setResetRow(boolean value)

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;

Parameter
NameDescription
valueboolean

The resetRow to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setRowKey(ByteString value)

public ReadRowsResponse.CellChunk.Builder setRowKey(ByteString value)

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;

Parameter
NameDescription
valueByteString

The rowKey to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setTimestampMicros(long value)

public ReadRowsResponse.CellChunk.Builder setTimestampMicros(long value)

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;

Parameter
NameDescription
valuelong

The timestampMicros to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsResponse.CellChunk.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder
Overrides

setValue(ByteString value)

public ReadRowsResponse.CellChunk.Builder setValue(ByteString value)

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;

Parameter
NameDescription
valueByteString

The value to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.

setValueSize(int value)

public ReadRowsResponse.CellChunk.Builder setValueSize(int value)

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;

Parameter
NameDescription
valueint

The valueSize to set.

Returns
TypeDescription
ReadRowsResponse.CellChunk.Builder

This builder for chaining.