com.google.cloud.bigtable.grpc

Class BigtableDataClientWrapper

java.lang.Object

com.google.cloud.bigtable.grpc.BigtableDataClientWrapper

All Implemented Interfaces:

IBigtableDataClient

@InternalApi(value="For internal usage only - please use BigtableDataClient")
public class BigtableDataClientWrapper
extends Object
implements IBigtableDataClient

This class implements the IBigtableDataClient interface and wraps BigtableDataClient with Google-cloud-java's models.

For internal use only - public for technical reasons.

See BigtableSession.getDataClient() as a public alternative.

Constructor Summary

Constructors

Constructor and Description
BigtableDataClientWrapper(BigtableDataClient bigtableDataClient, com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext)

Method Summary

Modifier and Type	Method and Description
Boolean	checkAndMutateRow(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation) Mutate a row atomically dependent on a precondition.
com.google.api.core.ApiFuture<Boolean>	checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation) Mutate a row atomically dependent on a precondition.
IBulkMutation	createBulkMutationBatcher(String tableId) Creates IBulkMutation batcher.
void	mutateRow(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation) Mutate a row atomically.
com.google.api.core.ApiFuture<Void>	mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation) Mutate a row atomically.
ResultScanner<FlatRow>	readFlatRows(com.google.cloud.bigtable.data.v2.models.Query request) Perform a scan over FlatRows, in key order.
com.google.api.core.ApiFuture<List<FlatRow>>	readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request) Read multiple FlatRows into an in-memory list, in key order.
void	readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request, io.grpc.stub.StreamObserver<FlatRow> observer) Read FlatRow asynchronously, and pass them to a stream observer to be processed.
List<FlatRow>	readFlatRowsList(com.google.cloud.bigtable.data.v2.models.Query request) Returns a list of FlatRows, in key order.
com.google.cloud.bigtable.data.v2.models.Row	readModifyWriteRow(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow) Perform an atomic read-modify-write operation on a row.
com.google.api.core.ApiFuture<com.google.cloud.bigtable.data.v2.models.Row>	readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow) Perform an atomic read-modify-write operation on a row.
ResultScanner<com.google.cloud.bigtable.data.v2.models.Row>	readRows(com.google.cloud.bigtable.data.v2.models.Query request) Perform a scan over Rows, in key order.
com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.Row>>	readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request) Read multiple Rows into an in-memory list, in key order.
List<com.google.cloud.bigtable.data.v2.models.KeyOffset>	sampleRowKeys(String tableId) Sample row keys from a table.
com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>>	sampleRowKeysAsync(String tableId) Sample row keys from a table, returning a Future that will complete when the sampling has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableDataClientWrapper

public BigtableDataClientWrapper(BigtableDataClient bigtableDataClient,
                                 com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext)

Method Detail

mutateRow

public void mutateRow(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation)

Mutate a row atomically.

Specified by:

mutateRow in interface IBigtableDataClient

Parameters:

rowMutation - a RowMutation model object.

mutateRowAsync

public com.google.api.core.ApiFuture<Void> mutateRowAsync(com.google.cloud.bigtable.data.v2.models.RowMutation rowMutation)

Mutate a row atomically.

Specified by:

mutateRowAsync in interface IBigtableDataClient

Parameters:

rowMutation - a RowMutation model object.

Returns:

a ApiFuture of type Void will be set when request is successful otherwise exception will be thrown.

readModifyWriteRow

public com.google.cloud.bigtable.data.v2.models.Row readModifyWriteRow(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow)

Perform an atomic read-modify-write operation on a row.

Specified by:

readModifyWriteRow in interface IBigtableDataClient

Parameters:

readModifyWriteRow - a ReadModifyWriteRow model object.

Returns:

Row a modified row.

readModifyWriteRowAsync

public com.google.api.core.ApiFuture<com.google.cloud.bigtable.data.v2.models.Row> readModifyWriteRowAsync(com.google.cloud.bigtable.data.v2.models.ReadModifyWriteRow readModifyWriteRow)

Perform an atomic read-modify-write operation on a row.

Specified by:

readModifyWriteRowAsync in interface IBigtableDataClient

Parameters:

readModifyWriteRow - a ReadModifyWriteRow model object.

Returns:

a ApiFuture of type Row will be set when request is successful otherwise exception will be thrown.

createBulkMutationBatcher

public IBulkMutation createBulkMutationBatcher(String tableId)

Creates IBulkMutation batcher.

Specified by:

createBulkMutationBatcher in interface IBigtableDataClient

checkAndMutateRowAsync

public com.google.api.core.ApiFuture<Boolean> checkAndMutateRowAsync(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation)

Mutate a row atomically dependent on a precondition.

Specified by:

checkAndMutateRowAsync in interface IBigtableDataClient

Parameters:

conditionalRowMutation - a ConditionalRowMutation model object.

Returns:

a ApiFuture of type Boolean will be set when request is successful otherwise exception will be thrown.

checkAndMutateRow

public Boolean checkAndMutateRow(com.google.cloud.bigtable.data.v2.models.ConditionalRowMutation conditionalRowMutation)

Mutate a row atomically dependent on a precondition.

Specified by:

checkAndMutateRow in interface IBigtableDataClient

Parameters:

conditionalRowMutation - a ConditionalRowMutation model object.

Returns:

returns true if predicate returns any result.

sampleRowKeys

public List<com.google.cloud.bigtable.data.v2.models.KeyOffset> sampleRowKeys(String tableId)

Sample row keys from a table.

Specified by:

sampleRowKeys in interface IBigtableDataClient

Parameters:

tableId - a String object.

Returns:

an immutable List object.

sampleRowKeysAsync

public com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.KeyOffset>> sampleRowKeysAsync(String tableId)

Sample row keys from a table, returning a Future that will complete when the sampling has completed.

Specified by:

sampleRowKeysAsync in interface IBigtableDataClient

Parameters:

tableId - a String object.

Returns:

a ApiFuture object.

readRows

public ResultScanner<com.google.cloud.bigtable.data.v2.models.Row> readRows(com.google.cloud.bigtable.data.v2.models.Query request)

Perform a scan over Rows, in key order.

Specified by:

readRows in interface IBigtableDataClient

Parameters:

request - a Query object.

Returns:

a Row object.

readRowsAsync

public com.google.api.core.ApiFuture<List<com.google.cloud.bigtable.data.v2.models.Row>> readRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request)

Read multiple Rows into an in-memory list, in key order.

Specified by:

readRowsAsync in interface IBigtableDataClient

Parameters:

request - a Query object.

Returns:

a ApiFuture that will finish when all reads have completed.

readFlatRowsList

public List<FlatRow> readFlatRowsList(com.google.cloud.bigtable.data.v2.models.Query request)

Returns a list of FlatRows, in key order.

Specified by:

readFlatRowsList in interface IBigtableDataClient

Parameters:

request - a Query object.

Returns:

a List with FlatRows.

readFlatRows

public ResultScanner<FlatRow> readFlatRows(com.google.cloud.bigtable.data.v2.models.Query request)

Perform a scan over FlatRows, in key order.

Specified by:

readFlatRows in interface IBigtableDataClient

Parameters:

request - a Query object.

Returns:

a ResultScanner object.

readFlatRowsAsync

public com.google.api.core.ApiFuture<List<FlatRow>> readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request)

Read multiple FlatRows into an in-memory list, in key order.

Specified by:

readFlatRowsAsync in interface IBigtableDataClient

Parameters:

request - a Query object.

Returns:

a ApiFuture that will finish when all reads have completed.

readFlatRowsAsync

public void readFlatRowsAsync(com.google.cloud.bigtable.data.v2.models.Query request,
                              io.grpc.stub.StreamObserver<FlatRow> observer)

Read FlatRow asynchronously, and pass them to a stream observer to be processed.

Specified by:

readFlatRowsAsync in interface IBigtableDataClient

Parameters:

request - a Query object.

observer - a StreamObserver object.