com.google.bigtable.v2

Class ReadRowsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

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

@Generated
public final class ReadRowsRequest
extends com.google.protobuf.GeneratedMessage
implements ReadRowsRequestOrBuilder

 Request message for Bigtable.ReadRows.
 

Protobuf type google.bigtable.v2.ReadRowsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadRowsRequest.Builder Request message for Bigtable.ReadRows.
static class	ReadRowsRequest.RequestStatsView The desired view into RequestStats that should be returned in the response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_PROFILE_ID_FIELD_NUMBER
static int	AUTHORIZED_VIEW_NAME_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	MATERIALIZED_VIEW_NAME_FIELD_NUMBER
static int	REQUEST_STATS_VIEW_FIELD_NUMBER
static int	REVERSED_FIELD_NUMBER
static int	ROWS_FIELD_NUMBER
static int	ROWS_LIMIT_FIELD_NUMBER
static int	TABLE_NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAppProfileId() This value specifies routing for replication.
com.google.protobuf.ByteString	getAppProfileIdBytes() This value specifies routing for replication.
String	getAuthorizedViewName() Optional.
com.google.protobuf.ByteString	getAuthorizedViewNameBytes() Optional.
static ReadRowsRequest	getDefaultInstance()
ReadRowsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RowFilter	getFilter() The filter to apply to the contents of the specified row(s).
RowFilterOrBuilder	getFilterOrBuilder() The filter to apply to the contents of the specified row(s).
String	getMaterializedViewName() Optional.
com.google.protobuf.ByteString	getMaterializedViewNameBytes() Optional.
com.google.protobuf.Parser<ReadRowsRequest>	getParserForType()
ReadRowsRequest.RequestStatsView	getRequestStatsView() The view into RequestStats, as described above.
int	getRequestStatsViewValue() The view into RequestStats, as described above.
boolean	getReversed() Experimental API - Please note that this API is currently experimental and can change in the future.
RowSet	getRows() The row keys and/or ranges to read sequentially.
long	getRowsLimit() The read will stop after committing to N rows' worth of results.
RowSetOrBuilder	getRowsOrBuilder() The row keys and/or ranges to read sequentially.
int	getSerializedSize()
String	getTableName() Optional.
com.google.protobuf.ByteString	getTableNameBytes() Optional.
boolean	hasFilter() 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.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReadRowsRequest.Builder	newBuilder()
static ReadRowsRequest.Builder	newBuilder(ReadRowsRequest prototype)
ReadRowsRequest.Builder	newBuilderForType()
protected ReadRowsRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
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(ByteBuffer data)
static ReadRowsRequest	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ReadRowsRequest>	parser()
ReadRowsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

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

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TABLE_NAME_FIELD_NUMBER

public static final int TABLE_NAME_FIELD_NUMBER

See Also:

Constant Field Values

AUTHORIZED_VIEW_NAME_FIELD_NUMBER

public static final int AUTHORIZED_VIEW_NAME_FIELD_NUMBER

See Also:

Constant Field Values

MATERIALIZED_VIEW_NAME_FIELD_NUMBER

public static final int MATERIALIZED_VIEW_NAME_FIELD_NUMBER

See Also:

Constant Field Values

APP_PROFILE_ID_FIELD_NUMBER

public static final int APP_PROFILE_ID_FIELD_NUMBER

See Also:

Constant Field Values

ROWS_FIELD_NUMBER

public static final int ROWS_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

ROWS_LIMIT_FIELD_NUMBER

public static final int ROWS_LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_STATS_VIEW_FIELD_NUMBER

public static final int REQUEST_STATS_VIEW_FIELD_NUMBER

See Also:

Constant Field Values

REVERSED_FIELD_NUMBER

public static final int REVERSED_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getTableName

public 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) = { ... }

Specified by:

getTableName in interface ReadRowsRequestOrBuilder

Returns:

The tableName.

getTableNameBytes

public com.google.protobuf.ByteString getTableNameBytes()

 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) = { ... }

Specified by:

getTableNameBytes in interface ReadRowsRequestOrBuilder

Returns:

The bytes for tableName.

getAuthorizedViewName

public 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) = { ... }

Specified by:

getAuthorizedViewName in interface ReadRowsRequestOrBuilder

Returns:

The authorizedViewName.

getAuthorizedViewNameBytes

public com.google.protobuf.ByteString getAuthorizedViewNameBytes()

 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) = { ... }

Specified by:

getAuthorizedViewNameBytes in interface ReadRowsRequestOrBuilder

Returns:

The bytes for authorizedViewName.

getMaterializedViewName

public String getMaterializedViewName()

 Optional. The unique name of the MaterializedView from which to read.

 Values are of the form
 `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
 

string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getMaterializedViewName in interface ReadRowsRequestOrBuilder

Returns:

The materializedViewName.

getMaterializedViewNameBytes

public com.google.protobuf.ByteString getMaterializedViewNameBytes()

 Optional. The unique name of the MaterializedView from which to read.

 Values are of the form
 `projects/<project>/instances/<instance>/materializedViews/<materialized_view>`.
 

string materialized_view_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getMaterializedViewNameBytes in interface ReadRowsRequestOrBuilder

Returns:

The bytes for materializedViewName.

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.

getRowsOrBuilder

public RowSetOrBuilder 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 interface ReadRowsRequestOrBuilder

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.

getFilterOrBuilder

public RowFilterOrBuilder 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 interface ReadRowsRequestOrBuilder

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.

getRequestStatsView

public ReadRowsRequest.RequestStatsView getRequestStatsView()

 The view into RequestStats, as described above.
 

.google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;

Specified by:

getRequestStatsView in interface ReadRowsRequestOrBuilder

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

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

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(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static ReadRowsRequest parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReadRowsRequest parseDelimitedFrom(InputStream input)
                                          throws IOException

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

public ReadRowsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReadRowsRequest.Builder newBuilder()

newBuilder

public static ReadRowsRequest.Builder newBuilder(ReadRowsRequest prototype)

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.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static ReadRowsRequest getDefaultInstance()

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

getDefaultInstanceForType

public ReadRowsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder