Package com.google.bigtable.v2
Class ReadRowsRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.bigtable.v2.ReadRowsRequest
- All Implemented Interfaces:
ReadRowsRequestOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class ReadRowsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReadRowsRequestOrBuilder
Request message for Bigtable.ReadRows.Protobuf type
google.bigtable.v2.ReadRowsRequest
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Request message for Bigtable.ReadRows.static enum
The desired view into RequestStats that should be returned in the response.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
This value specifies routing for replication.com.google.protobuf.ByteString
This value specifies routing for replication.static ReadRowsRequest
static final 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).com.google.protobuf.Parser<ReadRowsRequest>
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.long
The read will stop after committing to N rows' worth of results.The row keys and/or ranges to read sequentially.int
Required.com.google.protobuf.ByteString
Required.boolean
The filter to apply to the contents of the specified row(s).int
hashCode()
boolean
hasRows()
The row keys and/or ranges to read sequentially.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static ReadRowsRequest.Builder
static ReadRowsRequest.Builder
newBuilder
(ReadRowsRequest prototype) protected ReadRowsRequest.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ReadRowsRequest
parseDelimitedFrom
(InputStream input) static ReadRowsRequest
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadRowsRequest
parseFrom
(byte[] data) static ReadRowsRequest
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadRowsRequest
parseFrom
(com.google.protobuf.ByteString data) static ReadRowsRequest
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadRowsRequest
parseFrom
(com.google.protobuf.CodedInputStream input) static ReadRowsRequest
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadRowsRequest
parseFrom
(InputStream input) static ReadRowsRequest
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadRowsRequest
parseFrom
(ByteBuffer data) static ReadRowsRequest
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ReadRowsRequest>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
TABLE_NAME_FIELD_NUMBER
public static final int TABLE_NAME_FIELD_NUMBER- See Also:
-
APP_PROFILE_ID_FIELD_NUMBER
public static final int APP_PROFILE_ID_FIELD_NUMBER- See Also:
-
ROWS_FIELD_NUMBER
public static final int ROWS_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
ROWS_LIMIT_FIELD_NUMBER
public static final int ROWS_LIMIT_FIELD_NUMBER- See Also:
-
REQUEST_STATS_VIEW_FIELD_NUMBER
public static final int REQUEST_STATS_VIEW_FIELD_NUMBER- See Also:
-
REVERSED_FIELD_NUMBER
public static final int REVERSED_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
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
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ReadRowsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadRowsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadRowsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadRowsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadRowsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ReadRowsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ReadRowsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ReadRowsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ReadRowsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ReadRowsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ReadRowsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-