Package com.google.bigtable.v2
Class ReadRowsRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
com.google.bigtable.v2.ReadRowsRequest.Builder
- All Implemented Interfaces:
ReadRowsRequestOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- ReadRowsRequest
public static final class ReadRowsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
implements ReadRowsRequestOrBuilder
Request message for Bigtable.ReadRows.Protobuf type
google.bigtable.v2.ReadRowsRequest
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
This value specifies routing for replication.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) The filter to apply to the contents of the specified row(s).clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) The view into RequestStats, as described above.Experimental API - Please note that this API is currently experimental and can change in the future.The row keys and/or ranges to read sequentially.The read will stop after committing to N rows' worth of results.Required.clone()
This value specifies routing for replication.com.google.protobuf.ByteString
This value specifies routing for replication.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
The filter to apply to the contents of the specified row(s).The filter to apply to the contents of the specified row(s).The filter to apply to the contents of the specified row(s).The view into RequestStats, as described above.int
The view into RequestStats, as described above.boolean
Experimental API - Please note that this API is currently experimental and can change in the future.getRows()
The row keys and/or ranges to read sequentially.The row keys and/or ranges to read sequentially.long
The read will stop after committing to N rows' worth of results.The row keys and/or ranges to read sequentially.Required.com.google.protobuf.ByteString
Required.boolean
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.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFilter
(RowFilter value) The filter to apply to the contents of the specified row(s).mergeFrom
(ReadRowsRequest other) mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) The row keys and/or ranges to read sequentially.final ReadRowsRequest.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) setAppProfileId
(String value) This value specifies routing for replication.setAppProfileIdBytes
(com.google.protobuf.ByteString value) This value specifies routing for replication.The filter to apply to the contents of the specified row(s).setFilter
(RowFilter.Builder builderForValue) The filter to apply to the contents of the specified row(s).setRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) The view into RequestStats, as described above.setRequestStatsViewValue
(int value) The view into RequestStats, as described above.setReversed
(boolean value) Experimental API - Please note that this API is currently experimental and can change in the future.The row keys and/or ranges to read sequentially.setRows
(RowSet.Builder builderForValue) The row keys and/or ranges to read sequentially.setRowsLimit
(long value) The read will stop after committing to N rows' worth of results.setTableName
(String value) Required.setTableNameBytes
(com.google.protobuf.ByteString value) Required.final ReadRowsRequest.Builder
setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
setField
public ReadRowsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
setRepeatedField
public ReadRowsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
addRepeatedField
public ReadRowsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
mergeFrom
public ReadRowsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>
- Throws:
IOException
-
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) = { ... }
- Specified by:
getTableName
in interfaceReadRowsRequestOrBuilder
- Returns:
- The tableName.
-
getTableNameBytes
public com.google.protobuf.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) = { ... }
- Specified by:
getTableNameBytes
in interfaceReadRowsRequestOrBuilder
- Returns:
- The bytes for tableName.
-
setTableName
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) = { ... }
- Parameters:
value
- The tableName to set.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
setTableNameBytes
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) = { ... }
- Parameters:
value
- The bytes for tableName to set.- Returns:
- This builder for chaining.
-
getAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;
- Specified by:
getAppProfileId
in interfaceReadRowsRequestOrBuilder
- Returns:
- The appProfileId.
-
getAppProfileIdBytes
public 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;
- Specified by:
getAppProfileIdBytes
in interfaceReadRowsRequestOrBuilder
- Returns:
- The bytes for appProfileId.
-
setAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;
- Parameters:
value
- The appProfileId to set.- Returns:
- This builder for chaining.
-
clearAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;
- Returns:
- This builder for chaining.
-
setAppProfileIdBytes
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string app_profile_id = 5;
- Parameters:
value
- The bytes for appProfileId to set.- Returns:
- This builder for chaining.
-
hasRows
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;
- Specified by:
hasRows
in interfaceReadRowsRequestOrBuilder
- Returns:
- Whether the rows field is set.
-
getRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
- Specified by:
getRows
in interfaceReadRowsRequestOrBuilder
- Returns:
- The rows.
-
setRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
-
setRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
-
mergeRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
-
clearRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
-
getRowsBuilder
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
-
getRowsOrBuilder
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
.google.bigtable.v2.RowSet rows = 2;
- Specified by:
getRowsOrBuilder
in interfaceReadRowsRequestOrBuilder
-
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;
- Specified by:
hasFilter
in interfaceReadRowsRequestOrBuilder
- Returns:
- Whether the filter field is set.
-
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;
- Specified by:
getFilter
in interfaceReadRowsRequestOrBuilder
- Returns:
- The filter.
-
setFilter
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;
-
setFilter
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;
-
mergeFilter
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;
-
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;
-
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;
-
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;
- Specified by:
getFilterOrBuilder
in interfaceReadRowsRequestOrBuilder
-
getRowsLimit
public 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;
- Specified by:
getRowsLimit
in interfaceReadRowsRequestOrBuilder
- Returns:
- The rowsLimit.
-
setRowsLimit
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
int64 rows_limit = 4;
- Parameters:
value
- The rowsLimit to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
getRequestStatsViewValue
public int getRequestStatsViewValue()The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
- Specified by:
getRequestStatsViewValue
in interfaceReadRowsRequestOrBuilder
- Returns:
- The enum numeric value on the wire for requestStatsView.
-
setRequestStatsViewValue
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
- Parameters:
value
- The enum numeric value on the wire for requestStatsView to set.- Returns:
- This builder for chaining.
-
getRequestStatsView
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
- Specified by:
getRequestStatsView
in interfaceReadRowsRequestOrBuilder
- Returns:
- The requestStatsView.
-
setRequestStatsView
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
- Parameters:
value
- The requestStatsView to set.- Returns:
- This builder for chaining.
-
clearRequestStatsView
The view into RequestStats, as described above.
.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
- Returns:
- This builder for chaining.
-
getReversed
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;
- Specified by:
getReversed
in interfaceReadRowsRequestOrBuilder
- Returns:
- The reversed.
-
setReversed
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;
- Parameters:
value
- The reversed to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final ReadRowsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-
mergeUnknownFields
public final ReadRowsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>
-