com.google.cloud.bigtable.data.v2.models

Class Query

java.lang.Object

com.google.cloud.bigtable.data.v2.models.Query

All Implemented Interfaces:

Serializable

public final class Query
extends Object
implements Serializable

A simple wrapper to construct a query for the ReadRows RPC.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Query	create(String tableId) Constructs a new Query object for the specified table id.
Query	filter(Filters.Filter filter) Sets the filter to apply to each row.
Query	limit(long limit) Limits the number of rows that can be returned
Query	prefix(com.google.protobuf.ByteString prefix)
Query	prefix(String prefix)
Query	range(com.google.protobuf.ByteString start, com.google.protobuf.ByteString end) Adds a range to be looked up.
Query	range(Range.ByteStringRange range) Adds a range to be looked up.
Query	range(String start, String end) Adds a range to be looked up.
Query	rowKey(com.google.protobuf.ByteString key) Adds a key to looked up
Query	rowKey(String key) Adds a key to looked up
com.google.bigtable.v2.ReadRowsRequest	toProto(RequestContext requestContext) Creates the request protobuf.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Query create(String tableId)

Constructs a new Query object for the specified table id. The table id will be combined with the instance name specified in the BigtableDataSettings.

rowKey

public Query rowKey(String key)

Adds a key to looked up

rowKey

public Query rowKey(com.google.protobuf.ByteString key)

Adds a key to looked up

prefix

public Query prefix(com.google.protobuf.ByteString prefix)

prefix

public Query prefix(String prefix)

range

public Query range(String start,
                   String end)

Adds a range to be looked up.

Parameters:

start - The beginning of the range (inclusive). Can be null to represent negative infinity.

end - The end of the range (exclusive). Can be null to represent positive infinity.

range

public Query range(com.google.protobuf.ByteString start,
                   com.google.protobuf.ByteString end)

Adds a range to be looked up.

Parameters:

start - The beginning of the range (inclusive). Can be null to represent negative infinity.

end - The end of the range (exclusive). Can be null to represent positive infinity.

range

public Query range(Range.ByteStringRange range)

Adds a range to be looked up.

filter

public Query filter(Filters.Filter filter)

Sets the filter to apply to each row. Only one filter can be set at a time. To use multiple filters, please use Filters.interleave() or Filters.chain().

limit

public Query limit(long limit)

Limits the number of rows that can be returned

toProto

@InternalApi
public com.google.bigtable.v2.ReadRowsRequest toProto(RequestContext requestContext)

Creates the request protobuf. This method is considered an internal implementation detail and not meant to be used by applications.