Package com.google.bigtable.v2

Class 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 Detail

      • 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.Builder<ReadRowsRequest.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public ReadRowsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • clearField

        public ReadRowsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • clearOneof

        public ReadRowsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.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 interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • addRepeatedField

        public ReadRowsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • mergeFrom

        public ReadRowsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.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 interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRowsRequest.Builder>
        Throws:
        IOException

      • 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.

      • setTableName

        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) = { ... }
        Parameters:
        value - The tableName to set.
        Returns:
        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:
        This builder for chaining.

      • setTableNameBytes

        public ReadRowsRequest.Builder setTableNameBytes​(com.google.protobuf.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) = { ... }
        Parameters:
        value - The bytes for tableName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setAppProfileId

        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;
        Parameters:
        value - The appProfileId to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setAppProfileIdBytes

        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;
        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 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.

      • setRows

        public 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;

      • setRows

        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;

      • mergeRows

        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;

      • clearRows

        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;

      • getRowsBuilder

        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;

      • 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.

      • setFilter

        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;

      • setFilter

        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;

      • mergeFilter

        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;

      • 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;

      • 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;

      • 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.

      • setRowsLimit

        public 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;
        Parameters:
        value - The rowsLimit to set.
        Returns:
        This builder for chaining.

      • clearRowsLimit

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

      • setRequestStatsViewValue

        public ReadRowsRequest.Builder setRequestStatsViewValue​(int value)
         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.

      • setRequestStatsView

        public ReadRowsRequest.Builder setRequestStatsView​(ReadRowsRequest.RequestStatsView value)
         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

        public ReadRowsRequest.Builder 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 interface ReadRowsRequestOrBuilder
        Returns:
        The reversed.

      • setReversed

        public 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;
        Parameters:
        value - The reversed to set.
        Returns:
        This builder for chaining.

      • clearReversed

        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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ReadRowsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>

      • mergeUnknownFields

        public final ReadRowsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRowsRequest.Builder>