public static final class ReadRowsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ReadRowsRequest.Builder> implements ReadRowsRequestOrBuilder
Request message for Bigtable.ReadRows.Protobuf type
google.bigtable.v2.ReadRowsRequest| Modifier and Type | Method and Description |
|---|---|
ReadRowsRequest |
build() |
ReadRowsRequest |
buildPartial() |
ReadRowsRequest.Builder |
clear() |
ReadRowsRequest.Builder |
clearAppProfileId()
This value specifies routing for replication.
|
ReadRowsRequest.Builder |
clearAuthorizedViewName()
Optional.
|
ReadRowsRequest.Builder |
clearFilter()
The filter to apply to the contents of the specified row(s).
|
ReadRowsRequest.Builder |
clearMaterializedViewName()
Optional.
|
ReadRowsRequest.Builder |
clearRequestStatsView()
The view into RequestStats, as described above.
|
ReadRowsRequest.Builder |
clearReversed()
Experimental API - Please note that this API is currently experimental
and can change in the future.
|
ReadRowsRequest.Builder |
clearRows()
The row keys and/or ranges to read sequentially.
|
ReadRowsRequest.Builder |
clearRowsLimit()
The read will stop after committing to N rows' worth of results.
|
ReadRowsRequest.Builder |
clearTableName()
Optional.
|
String |
getAppProfileId()
This value specifies routing for replication.
|
com.google.protobuf.ByteString |
getAppProfileIdBytes()
This value specifies routing for replication.
|
String |
getAuthorizedViewName()
Optional.
|
com.google.protobuf.ByteString |
getAuthorizedViewNameBytes()
Optional.
|
ReadRowsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
RowFilter |
getFilter()
The filter to apply to the contents of the specified row(s).
|
RowFilter.Builder |
getFilterBuilder()
The filter to apply to the contents of the specified row(s).
|
RowFilterOrBuilder |
getFilterOrBuilder()
The filter to apply to the contents of the specified row(s).
|
String |
getMaterializedViewName()
Optional.
|
com.google.protobuf.ByteString |
getMaterializedViewNameBytes()
Optional.
|
ReadRowsRequest.RequestStatsView |
getRequestStatsView()
The view into RequestStats, as described above.
|
int |
getRequestStatsViewValue()
The view into RequestStats, as described above.
|
boolean |
getReversed()
Experimental API - Please note that this API is currently experimental
and can change in the future.
|
RowSet |
getRows()
The row keys and/or ranges to read sequentially.
|
RowSet.Builder |
getRowsBuilder()
The row keys and/or ranges to read sequentially.
|
long |
getRowsLimit()
The read will stop after committing to N rows' worth of results.
|
RowSetOrBuilder |
getRowsOrBuilder()
The row keys and/or ranges to read sequentially.
|
String |
getTableName()
Optional.
|
com.google.protobuf.ByteString |
getTableNameBytes()
Optional.
|
boolean |
hasFilter()
The filter to apply to the contents of the specified row(s).
|
boolean |
hasRows()
The row keys and/or ranges to read sequentially.
|
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ReadRowsRequest.Builder |
mergeFilter(RowFilter value)
The filter to apply to the contents of the specified row(s).
|
ReadRowsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ReadRowsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ReadRowsRequest.Builder |
mergeFrom(ReadRowsRequest other) |
ReadRowsRequest.Builder |
mergeRows(RowSet value)
The row keys and/or ranges to read sequentially.
|
ReadRowsRequest.Builder |
setAppProfileId(String value)
This value specifies routing for replication.
|
ReadRowsRequest.Builder |
setAppProfileIdBytes(com.google.protobuf.ByteString value)
This value specifies routing for replication.
|
ReadRowsRequest.Builder |
setAuthorizedViewName(String value)
Optional.
|
ReadRowsRequest.Builder |
setAuthorizedViewNameBytes(com.google.protobuf.ByteString value)
Optional.
|
ReadRowsRequest.Builder |
setFilter(RowFilter.Builder builderForValue)
The filter to apply to the contents of the specified row(s).
|
ReadRowsRequest.Builder |
setFilter(RowFilter value)
The filter to apply to the contents of the specified row(s).
|
ReadRowsRequest.Builder |
setMaterializedViewName(String value)
Optional.
|
ReadRowsRequest.Builder |
setMaterializedViewNameBytes(com.google.protobuf.ByteString value)
Optional.
|
ReadRowsRequest.Builder |
setRequestStatsView(ReadRowsRequest.RequestStatsView value)
The view into RequestStats, as described above.
|
ReadRowsRequest.Builder |
setRequestStatsViewValue(int value)
The view into RequestStats, as described above.
|
ReadRowsRequest.Builder |
setReversed(boolean value)
Experimental API - Please note that this API is currently experimental
and can change in the future.
|
ReadRowsRequest.Builder |
setRows(RowSet.Builder builderForValue)
The row keys and/or ranges to read sequentially.
|
ReadRowsRequest.Builder |
setRows(RowSet value)
The row keys and/or ranges to read sequentially.
|
ReadRowsRequest.Builder |
setRowsLimit(long value)
The read will stop after committing to N rows' worth of results.
|
ReadRowsRequest.Builder |
setTableName(String value)
Optional.
|
ReadRowsRequest.Builder |
setTableNameBytes(com.google.protobuf.ByteString value)
Optional.
|
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ReadRowsRequest.Builder>public ReadRowsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<ReadRowsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ReadRowsRequest.Builder>public ReadRowsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ReadRowsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ReadRowsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ReadRowsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>public ReadRowsRequest.Builder mergeFrom(ReadRowsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<ReadRowsRequest.Builder>public ReadRowsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>IOExceptionpublic String getTableName()
Optional. 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) = OPTIONAL, (.google.api.resource_reference) = { ... }
getTableName in interface ReadRowsRequestOrBuilderpublic com.google.protobuf.ByteString getTableNameBytes()
Optional. 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) = OPTIONAL, (.google.api.resource_reference) = { ... }
getTableNameBytes in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setTableName(String value)
Optional. 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) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The tableName to set.public ReadRowsRequest.Builder clearTableName()
Optional. 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) = OPTIONAL, (.google.api.resource_reference) = { ... }
public ReadRowsRequest.Builder setTableNameBytes(com.google.protobuf.ByteString value)
Optional. 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) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for tableName to set.public String getAuthorizedViewName()
Optional. The unique name of the AuthorizedView from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
string authorized_view_name = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getAuthorizedViewName in interface ReadRowsRequestOrBuilderpublic com.google.protobuf.ByteString getAuthorizedViewNameBytes()
Optional. The unique name of the AuthorizedView from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
string authorized_view_name = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getAuthorizedViewNameBytes in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setAuthorizedViewName(String value)
Optional. The unique name of the AuthorizedView from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
string authorized_view_name = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The authorizedViewName to set.public ReadRowsRequest.Builder clearAuthorizedViewName()
Optional. The unique name of the AuthorizedView from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
string authorized_view_name = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public ReadRowsRequest.Builder setAuthorizedViewNameBytes(com.google.protobuf.ByteString value)
Optional. The unique name of the AuthorizedView from which to read. Values are of the form `projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>`.
string authorized_view_name = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for authorizedViewName to set.public String getMaterializedViewName()
Optional. The unique name of the MaterializedView from which to read. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getMaterializedViewName in interface ReadRowsRequestOrBuilderpublic com.google.protobuf.ByteString getMaterializedViewNameBytes()
Optional. The unique name of the MaterializedView from which to read. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
getMaterializedViewNameBytes in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setMaterializedViewName(String value)
Optional. The unique name of the MaterializedView from which to read. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The materializedViewName to set.public ReadRowsRequest.Builder clearMaterializedViewName()
Optional. The unique name of the MaterializedView from which to read. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
public ReadRowsRequest.Builder setMaterializedViewNameBytes(com.google.protobuf.ByteString value)
Optional. The unique name of the MaterializedView from which to read. Values are of the form `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
value - The bytes for materializedViewName to set.public String getAppProfileId()
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;getAppProfileId in interface ReadRowsRequestOrBuilderpublic com.google.protobuf.ByteString getAppProfileIdBytes()
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;getAppProfileIdBytes in interface ReadRowsRequestOrBuilderpublic 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;value - The appProfileId to set.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;public ReadRowsRequest.Builder setAppProfileIdBytes(com.google.protobuf.ByteString value)
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;value - The bytes for appProfileId to set.public boolean hasRows()
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;hasRows in interface ReadRowsRequestOrBuilderpublic RowSet getRows()
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;getRows in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setRows(RowSet value)
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;public ReadRowsRequest.Builder setRows(RowSet.Builder builderForValue)
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;public ReadRowsRequest.Builder mergeRows(RowSet value)
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;public ReadRowsRequest.Builder clearRows()
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;public RowSet.Builder getRowsBuilder()
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;public RowSetOrBuilder getRowsOrBuilder()
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;getRowsOrBuilder in interface ReadRowsRequestOrBuilderpublic 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;hasFilter in interface ReadRowsRequestOrBuilderpublic 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;getFilter in interface ReadRowsRequestOrBuilderpublic 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;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;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;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;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;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;getFilterOrBuilder in interface ReadRowsRequestOrBuilderpublic long getRowsLimit()
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
int64 rows_limit = 4;getRowsLimit in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setRowsLimit(long value)
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
int64 rows_limit = 4;value - The rowsLimit to set.public ReadRowsRequest.Builder clearRowsLimit()
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
int64 rows_limit = 4;public int getRequestStatsViewValue()
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;getRequestStatsViewValue in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setRequestStatsViewValue(int value)
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;value - The enum numeric value on the wire for requestStatsView to set.public ReadRowsRequest.RequestStatsView getRequestStatsView()
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;getRequestStatsView in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setRequestStatsView(ReadRowsRequest.RequestStatsView value)
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;value - The requestStatsView to set.public ReadRowsRequest.Builder clearRequestStatsView()
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;public boolean getReversed()
Experimental API - Please note that this API is currently experimental
and can change in the future.
Return rows in lexiographical descending order of the row keys. The row
contents will not be affected by this flag.
Example result set:
[
{key: "k2", "f:col1": "v1", "f:col2": "v1"},
{key: "k1", "f:col1": "v2", "f:col2": "v2"}
]
bool reversed = 7;getReversed in interface ReadRowsRequestOrBuilderpublic ReadRowsRequest.Builder setReversed(boolean value)
Experimental API - Please note that this API is currently experimental
and can change in the future.
Return rows in lexiographical descending order of the row keys. The row
contents will not be affected by this flag.
Example result set:
[
{key: "k2", "f:col1": "v1", "f:col2": "v1"},
{key: "k1", "f:col1": "v2", "f:col2": "v2"}
]
bool reversed = 7;value - The reversed to set.public ReadRowsRequest.Builder clearReversed()
Experimental API - Please note that this API is currently experimental
and can change in the future.
Return rows in lexiographical descending order of the row keys. The row
contents will not be affected by this flag.
Example result set:
[
{key: "k2", "f:col1": "v1", "f:col2": "v1"},
{key: "k1", "f:col1": "v2", "f:col2": "v2"}
]
bool reversed = 7;Copyright © 2026 Google LLC. All rights reserved.