Package com.google.bigtable.v2

Class 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:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getTableName in interface ReadRowsRequestOrBuilder
        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 interface ReadRowsRequestOrBuilder
        Returns:
        The bytes for tableName.

      • 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;
        Specified by:
        getAppProfileId in interface ReadRowsRequestOrBuilder
        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 interface ReadRowsRequestOrBuilder
        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 interface ReadRowsRequestOrBuilder
        Returns:
        Whether the rows field is set.

      • getRows

        public RowSet 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 interface ReadRowsRequestOrBuilder
        Returns:
        The rows.

      • 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 interface ReadRowsRequestOrBuilder
        Returns:
        Whether the filter field is set.

      • 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;
        Specified by:
        getFilter in interface ReadRowsRequestOrBuilder
        Returns:
        The filter.

      • 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 interface ReadRowsRequestOrBuilder
        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 interface ReadRowsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for 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 interface ReadRowsRequestOrBuilder
        Returns:
        The reversed.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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

        public static ReadRowsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ReadRowsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ReadRowsRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ReadRowsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<ReadRowsRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<ReadRowsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ReadRowsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder