Class ReadRowsRequest.Builder (2.4.0)

Version 2.4.0

• 2.49.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public static final class ReadRowsRequest.Builder extends GeneratedMessageV3.Builder<ReadRowsRequest.Builder> implements ReadRowsRequestOrBuilder

Request message for Bigtable.ReadRows.

Protobuf type google.bigtable.v2.ReadRowsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadRowsRequest.Builder

Implements

ReadRowsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ReadRowsRequest build()

Returns

Type	Description
ReadRowsRequest

buildPartial()

public ReadRowsRequest buildPartial()

Returns

Type	Description
ReadRowsRequest

clear()

public ReadRowsRequest.Builder clear()

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAppProfileId()

public ReadRowsRequest.Builder clearAppProfileId()

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReadRowsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ReadRowsRequest.Builder clearFilter()

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Returns

Type	Description
ReadRowsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ReadRowsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRows()

public ReadRowsRequest.Builder clearRows()

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Returns

Type	Description
ReadRowsRequest.Builder

clearRowsLimit()

public ReadRowsRequest.Builder clearRowsLimit()

The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.

int64 rows_limit = 4;

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

clearTableName()

public ReadRowsRequest.Builder clearTableName()

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

clone()

public ReadRowsRequest.Builder clone()

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAppProfileId()

public String getAppProfileId()

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Returns

Type	Description
String	The appProfileId.

getAppProfileIdBytes()

public ByteString getAppProfileIdBytes()

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Returns

Type	Description
ByteString	The bytes for appProfileId.

getDefaultInstanceForType()

public ReadRowsRequest getDefaultInstanceForType()

Returns

Type	Description
ReadRowsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public RowFilter getFilter()

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Returns

Type	Description
RowFilter	The filter.

getFilterBuilder()

public RowFilter.Builder getFilterBuilder()

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Returns

Type	Description
RowFilter.Builder

getFilterOrBuilder()

public RowFilterOrBuilder getFilterOrBuilder()

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Returns

Type	Description
RowFilterOrBuilder

getRows()

public RowSet getRows()

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Returns

Type	Description
RowSet	The rows.

getRowsBuilder()

public RowSet.Builder getRowsBuilder()

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Returns

Type	Description
RowSet.Builder

getRowsLimit()

public long getRowsLimit()

The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.

int64 rows_limit = 4;

Returns

Type	Description
long	The rowsLimit.

getRowsOrBuilder()

public RowSetOrBuilder getRowsOrBuilder()

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Returns

Type	Description
RowSetOrBuilder

getTableName()

public String getTableName()

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The tableName.

getTableNameBytes()

public ByteString getTableNameBytes()

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for tableName.

hasFilter()

public boolean hasFilter()

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Returns

Type	Description
boolean	Whether the filter field is set.

hasRows()

public boolean hasRows()

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Returns

Type	Description
boolean	Whether the rows field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFilter(RowFilter value)

public ReadRowsRequest.Builder mergeFilter(RowFilter value)

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Parameter

Name	Description
value	RowFilter

Returns

Type	Description
ReadRowsRequest.Builder

mergeFrom(ReadRowsRequest other)

public ReadRowsRequest.Builder mergeFrom(ReadRowsRequest other)

Parameter

Name	Description
other	ReadRowsRequest

Returns

Type	Description
ReadRowsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReadRowsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ReadRowsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRows(RowSet value)

public ReadRowsRequest.Builder mergeRows(RowSet value)

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Parameter

Name	Description
value	RowSet

Returns

Type	Description
ReadRowsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAppProfileId(String value)

public ReadRowsRequest.Builder setAppProfileId(String value)

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Parameter

Name	Description
value	String The appProfileId to set.

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

setAppProfileIdBytes(ByteString value)

public ReadRowsRequest.Builder setAppProfileIdBytes(ByteString value)

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Parameter

Name	Description
value	ByteString The bytes for appProfileId to set.

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReadRowsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(RowFilter value)

public ReadRowsRequest.Builder setFilter(RowFilter value)

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Parameter

Name	Description
value	RowFilter

Returns

Type	Description
ReadRowsRequest.Builder

setFilter(RowFilter.Builder builderForValue)

public ReadRowsRequest.Builder setFilter(RowFilter.Builder builderForValue)

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

.google.bigtable.v2.RowFilter filter = 3;

Parameter

Name	Description
builderForValue	RowFilter.Builder

Returns

Type	Description
ReadRowsRequest.Builder

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRows(RowSet value)

public ReadRowsRequest.Builder setRows(RowSet value)

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Parameter

Name	Description
value	RowSet

Returns

Type	Description
ReadRowsRequest.Builder

setRows(RowSet.Builder builderForValue)

public ReadRowsRequest.Builder setRows(RowSet.Builder builderForValue)

The row keys and/or ranges to read. If not specified, reads from all rows.

.google.bigtable.v2.RowSet rows = 2;

Parameter

Name	Description
builderForValue	RowSet.Builder

Returns

Type	Description
ReadRowsRequest.Builder

setRowsLimit(long value)

public ReadRowsRequest.Builder setRowsLimit(long value)

The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.

int64 rows_limit = 4;

Parameter

Name	Description
value	long The rowsLimit to set.

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

setTableName(String value)

public ReadRowsRequest.Builder setTableName(String value)

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	String The tableName to set.

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

setTableNameBytes(ByteString value)

public ReadRowsRequest.Builder setTableNameBytes(ByteString value)

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	ByteString The bytes for tableName to set.

Returns

Type	Description
ReadRowsRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReadRowsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ReadRowsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)