com.google.cloud.bigtable.grpc
Interface BigtableDataClient
-
- All Known Implementing Classes:
- BigtableDataGrpcClient
public interface BigtableDataClient
Interface to access v2 Bigtable data service methods.- Version:
- $Id: $Id
- Author:
- sduskis
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description com.google.bigtable.v2.CheckAndMutateRowResponse
checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)
Mutate a row atomically dependent on a precondition.ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse>
checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request)
Mutate a row atomically dependent on a precondition.com.google.bigtable.v2.MutateRowResponse
mutateRow(com.google.bigtable.v2.MutateRowRequest request)
Mutate a row atomically.ListenableFuture<com.google.bigtable.v2.MutateRowResponse>
mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request)
Mutate a row atomically.List<com.google.bigtable.v2.MutateRowsResponse>
mutateRows(com.google.bigtable.v2.MutateRowsRequest request)
Mutates multiple rows in a batch.ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>>
mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request)
Mutates multiple rows in a batch.ResultScanner<FlatRow>
readFlatRows(com.google.bigtable.v2.ReadRowsRequest request)
Perform a scan overFlatRow
s, in key order.ScanHandler
readFlatRows(com.google.bigtable.v2.ReadRowsRequest request, io.grpc.stub.StreamObserver<FlatRow> observer)
Perform a streaming read ofFlatRow
s in key order.ListenableFuture<List<FlatRow>>
readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
Read multipleFlatRow
s into an in-memory list, in key order.List<FlatRow>
readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request)
Returns a list ofFlatRow
s, in key order.com.google.bigtable.v2.ReadModifyWriteRowResponse
readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
Perform an atomic read-modify-write operation on a row.ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse>
readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
Perform an atomic read-modify-write operation on a row,ResultScanner<com.google.bigtable.v2.Row>
readRows(com.google.bigtable.v2.ReadRowsRequest request)
Perform a scan overRow
s, in key order.ListenableFuture<List<com.google.bigtable.v2.Row>>
readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
Read multipleRow
s into an in-memory list, in key order.List<com.google.bigtable.v2.SampleRowKeysResponse>
sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request)
Sample row keys from a table.ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>>
sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request)
Sample row keys from a table, returning a Future that will complete when the sampling has completed.void
setCallOptionsFactory(CallOptionsFactory callOptionsFactory)
Sets aCallOptionsFactory
which createsCallOptions
-
-
-
Method Detail
-
mutateRow
com.google.bigtable.v2.MutateRowResponse mutateRow(com.google.bigtable.v2.MutateRowRequest request)
Mutate a row atomically.- Parameters:
request
- aMutateRowRequest
object.- Returns:
- a
MutateRowResponse
object.
-
mutateRowAsync
ListenableFuture<com.google.bigtable.v2.MutateRowResponse> mutateRowAsync(com.google.bigtable.v2.MutateRowRequest request)
Mutate a row atomically.- Parameters:
request
- aMutateRowRequest
object.- Returns:
- a
ListenableFuture
that will finish when the mutation has completed.
-
mutateRows
List<com.google.bigtable.v2.MutateRowsResponse> mutateRows(com.google.bigtable.v2.MutateRowsRequest request)
Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.- Parameters:
request
- aMutateRowsRequest
object.- Returns:
- a
List
object.
-
mutateRowsAsync
ListenableFuture<List<com.google.bigtable.v2.MutateRowsResponse>> mutateRowsAsync(com.google.bigtable.v2.MutateRowsRequest request)
Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.- Parameters:
request
- aMutateRowsRequest
object.- Returns:
- a
ListenableFuture
that will finish when the mutations have all been completed.
-
checkAndMutateRow
com.google.bigtable.v2.CheckAndMutateRowResponse checkAndMutateRow(com.google.bigtable.v2.CheckAndMutateRowRequest request)
Mutate a row atomically dependent on a precondition.- Parameters:
request
- aCheckAndMutateRowRequest
object.- Returns:
- a
CheckAndMutateRowResponse
object.
-
checkAndMutateRowAsync
ListenableFuture<com.google.bigtable.v2.CheckAndMutateRowResponse> checkAndMutateRowAsync(com.google.bigtable.v2.CheckAndMutateRowRequest request)
Mutate a row atomically dependent on a precondition.- Parameters:
request
- aCheckAndMutateRowRequest
object.- Returns:
- a
ListenableFuture
that will finish when the mutation has completed.
-
readModifyWriteRow
com.google.bigtable.v2.ReadModifyWriteRowResponse readModifyWriteRow(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
Perform an atomic read-modify-write operation on a row.- Parameters:
request
- aReadModifyWriteRowRequest
object.- Returns:
- a
ReadModifyWriteRowResponse
object.
-
readModifyWriteRowAsync
ListenableFuture<com.google.bigtable.v2.ReadModifyWriteRowResponse> readModifyWriteRowAsync(com.google.bigtable.v2.ReadModifyWriteRowRequest request)
Perform an atomic read-modify-write operation on a row,- Parameters:
request
- aReadModifyWriteRowRequest
object.- Returns:
- a
ListenableFuture
that will finish when the mutation has completed.
-
sampleRowKeys
List<com.google.bigtable.v2.SampleRowKeysResponse> sampleRowKeys(com.google.bigtable.v2.SampleRowKeysRequest request)
Sample row keys from a table.- Parameters:
request
- aSampleRowKeysRequest
object.- Returns:
- an immutable
List
object.
-
sampleRowKeysAsync
ListenableFuture<List<com.google.bigtable.v2.SampleRowKeysResponse>> sampleRowKeysAsync(com.google.bigtable.v2.SampleRowKeysRequest request)
Sample row keys from a table, returning a Future that will complete when the sampling has completed.- Parameters:
request
- aSampleRowKeysRequest
object.- Returns:
- a
ListenableFuture
object.
-
readRows
ResultScanner<com.google.bigtable.v2.Row> readRows(com.google.bigtable.v2.ReadRowsRequest request)
Perform a scan overRow
s, in key order.- Parameters:
request
- aReadRowsRequest
object.- Returns:
- a
ResultScanner
object.
-
readRowsAsync
ListenableFuture<List<com.google.bigtable.v2.Row>> readRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
Read multipleRow
s into an in-memory list, in key order.- Parameters:
request
- aReadRowsRequest
object.- Returns:
- a
ListenableFuture
that will finish when all reads have completed.
-
readFlatRowsList
List<FlatRow> readFlatRowsList(com.google.bigtable.v2.ReadRowsRequest request)
Returns a list ofFlatRow
s, in key order.- Parameters:
request
- aReadRowsRequest
object.- Returns:
- a List with
FlatRow
s.
-
readFlatRows
ResultScanner<FlatRow> readFlatRows(com.google.bigtable.v2.ReadRowsRequest request)
Perform a scan overFlatRow
s, in key order.- Parameters:
request
- aReadRowsRequest
object.- Returns:
- a
ResultScanner
object.
-
readFlatRows
ScanHandler readFlatRows(com.google.bigtable.v2.ReadRowsRequest request, io.grpc.stub.StreamObserver<FlatRow> observer)
Perform a streaming read ofFlatRow
s in key order. It would be a good idea to turn on client side timeouts viaCallOptionsConfig.Builder.setUseTimeout(boolean)
.- Parameters:
request
- aReadRowsRequest
object.observer
- aStreamObserver
object- Returns:
- a
ScanHandler
which can be used to either cancel or timeout the request.
-
readFlatRowsAsync
ListenableFuture<List<FlatRow>> readFlatRowsAsync(com.google.bigtable.v2.ReadRowsRequest request)
Read multipleFlatRow
s into an in-memory list, in key order.- Parameters:
request
- aReadRowsRequest
object.- Returns:
- a
ListenableFuture
that will finish when all reads have completed.
-
setCallOptionsFactory
void setCallOptionsFactory(CallOptionsFactory callOptionsFactory)
Sets aCallOptionsFactory
which createsCallOptions
- Parameters:
callOptionsFactory
- aCallOptionsFactory
object.
-
-