Class ReadRowsRequest (2.13.0)

public final class ReadRowsRequest extends GeneratedMessageV3 implements ReadRowsRequestOrBuilder

Request message for Bigtable.ReadRows.

Protobuf type google.bigtable.v2.ReadRowsRequest

Static Fields

APP_PROFILE_ID_FIELD_NUMBER

public static final int APP_PROFILE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

ROWS_FIELD_NUMBER

public static final int ROWS_FIELD_NUMBER
Field Value
TypeDescription
int

ROWS_LIMIT_FIELD_NUMBER

public static final int ROWS_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_NAME_FIELD_NUMBER

public static final int TABLE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadRowsRequest getDefaultInstance()
Returns
TypeDescription
ReadRowsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadRowsRequest.Builder newBuilder()
Returns
TypeDescription
ReadRowsRequest.Builder

newBuilder(ReadRowsRequest prototype)

public static ReadRowsRequest.Builder newBuilder(ReadRowsRequest prototype)
Parameter
NameDescription
prototypeReadRowsRequest
Returns
TypeDescription
ReadRowsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReadRowsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadRowsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadRowsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadRowsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadRowsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadRowsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadRowsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadRowsRequest> parser()
Returns
TypeDescription
Parser<ReadRowsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
String

The appProfileId.

getAppProfileIdBytes()

public ByteString getAppProfileIdBytes()

This value specifies routing for replication. If not specified, the "default" application profile will be used.

string app_profile_id = 5;

Returns
TypeDescription
ByteString

The bytes for appProfileId.

getDefaultInstanceForType()

public ReadRowsRequest getDefaultInstanceForType()
Returns
TypeDescription
ReadRowsRequest

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;

Returns
TypeDescription
RowFilter

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;

Returns
TypeDescription
RowFilterOrBuilder

getParserForType()

public Parser<ReadRowsRequest> getParserForType()
Returns
TypeDescription
Parser<ReadRowsRequest>
Overrides

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;

Returns
TypeDescription
RowSet

The rows.

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;

Returns
TypeDescription
long

The rowsLimit.

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;

Returns
TypeDescription
RowSetOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
String

The tableName.

getTableNameBytes()

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

Returns
TypeDescription
ByteString

The bytes for tableName.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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;

Returns
TypeDescription
boolean

Whether the filter field is set.

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;

Returns
TypeDescription
boolean

Whether the rows field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadRowsRequest.Builder newBuilderForType()
Returns
TypeDescription
ReadRowsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadRowsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadRowsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadRowsRequest.Builder toBuilder()
Returns
TypeDescription
ReadRowsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException