/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/bigtable/v2/bigtable.proto
// Protobuf Java Version: 3.25.2
package com.google.bigtable.v2;
public interface ReadRowsRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.ReadRowsRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The tableName.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for tableName.
*/
com.google.protobuf.ByteString getTableNameBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The authorizedViewName.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for authorizedViewName.
*/
com.google.protobuf.ByteString getAuthorizedViewNameBytes();
/**
*
*
*
* This value specifies routing for replication. If not specified, the
* "default" application profile will be used.
*
*
* string app_profile_id = 5;
*
* @return The appProfileId.
*/
java.lang.String getAppProfileId();
/**
*
*
*
* This value specifies routing for replication. If not specified, the
* "default" application profile will be used.
*
*
* string app_profile_id = 5;
*
* @return The bytes for appProfileId.
*/
com.google.protobuf.ByteString getAppProfileIdBytes();
/**
*
*
*
* The row keys and/or ranges to read sequentially. If not specified, reads
* from all rows.
*
*
* .google.bigtable.v2.RowSet rows = 2;
*
* @return Whether the rows field is set.
*/
boolean hasRows();
/**
*
*
*
* The row keys and/or ranges to read sequentially. If not specified, reads
* from all rows.
*
*
* .google.bigtable.v2.RowSet rows = 2;
*
* @return The rows.
*/
com.google.bigtable.v2.RowSet getRows();
/**
*
*
*
* The row keys and/or ranges to read sequentially. If not specified, reads
* from all rows.
*
*
* .google.bigtable.v2.RowSet rows = 2;
*/
com.google.bigtable.v2.RowSetOrBuilder getRowsOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the filter field is set.
*/
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;
*
* @return The filter.
*/
com.google.bigtable.v2.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;
*/
com.google.bigtable.v2.RowFilterOrBuilder getFilterOrBuilder();
/**
*
*
*
* The read will stop after committing to N rows' worth of results. The
* default (zero) is to return all results.
*
*
* int64 rows_limit = 4;
*
* @return The rowsLimit.
*/
long getRowsLimit();
/**
*
*
*
* The view into RequestStats, as described above.
*
*
* .google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
*
* @return The enum numeric value on the wire for requestStatsView.
*/
int getRequestStatsViewValue();
/**
*
*
*
* The view into RequestStats, as described above.
*
*
* .google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
*
* @return The requestStatsView.
*/
com.google.bigtable.v2.ReadRowsRequest.RequestStatsView getRequestStatsView();
/**
*
*
*
* 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;
*
* @return The reversed.
*/
boolean getReversed();
}
