com.google.cloud.bigtable.grpc.async

Class AsyncExecutor

java.lang.Object

com.google.cloud.bigtable.grpc.async.AsyncExecutor

public class AsyncExecutor
extends Object

This class provides management of asynchronous Bigtable RPCs. It ensures that there aren't too many concurrent, in flight asynchronous RPCs and also makes sure that the memory used by the requests doesn't exceed a threshold.

Version:

$Id: $Id

Author:

sduskis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AsyncExecutor.AsyncCall<RequestT,ResponseT>

Field Summary

Fields

Modifier and Type	Field and Description
protected static AsyncExecutor.AsyncCall<CheckAndMutateRowRequest,CheckAndMutateRowResponse>	CHECK_AND_MUTATE_ASYNC Calls BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest).
protected static Logger	LOG Constant LOG
protected static AsyncExecutor.AsyncCall<MutateRowRequest,MutateRowResponse>	MUTATE_ROW_ASYNC Calls BigtableDataClient.mutateRowAsync(MutateRowRequest).
protected static AsyncExecutor.AsyncCall<MutateRowsRequest,List<MutateRowsResponse>>	MUTATE_ROWS_ASYNC Calls BigtableDataClient.mutateRowsAsync(MutateRowsRequest).
protected static AsyncExecutor.AsyncCall<ReadRowsRequest,List<FlatRow>>	READ_FLAT_ROWS_ASYNC Calls BigtableDataClient.readRowsAsync(ReadRowsRequest).
protected static AsyncExecutor.AsyncCall<ReadModifyWriteRowRequest,ReadModifyWriteRowResponse>	READ_MODIFY_WRITE_ASYNC Calls BigtableDataClient.readModifyWriteRowAsync(ReadModifyWriteRowRequest).
protected static AsyncExecutor.AsyncCall<ReadRowsRequest,List<Row>>	READ_ROWS_ASYNC Calls BigtableDataClient.readRowsAsync(ReadRowsRequest).

Constructor Summary

Constructors

Constructor and Description
AsyncExecutor(BigtableDataClient client, RpcThrottler rpcThrottler) Constructor for AsyncExecutor.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<CheckAndMutateRowResponse>	checkAndMutateRowAsync(CheckAndMutateRowRequest request) Performs a BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest) on the CheckAndMutateRowRequest.
com.google.common.util.concurrent.ListenableFuture<CheckAndMutateRowResponse>	checkAndMutateRowAsync(CheckAndMutateRowRequest request, long operationId) Performs a BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest) on the CheckAndMutateRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).
void	flush() Waits until all operations managed by the RpcThrottler complete.
BigtableDataClient	getClient() Getter for the field client.
long	getMaxHeapSize() getMaxHeapSize.
RpcThrottler	getRpcThrottler() Getter for the field rpcThrottler.
boolean	hasInflightRequests() hasInflightRequests.
com.google.common.util.concurrent.ListenableFuture<MutateRowResponse>	mutateRowAsync(MutateRowRequest request) Performs a BigtableDataClient.mutateRowAsync(MutateRowRequest) on the MutateRowRequest.
com.google.common.util.concurrent.ListenableFuture<MutateRowResponse>	mutateRowAsync(MutateRowRequest request, long operationId) Performs a BigtableDataClient.mutateRowAsync(MutateRowRequest) on the MutateRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).
com.google.common.util.concurrent.ListenableFuture<List<MutateRowsResponse>>	mutateRowAsync(MutateRowsRequest request, long operationId) Performs a BigtableDataClient.mutateRowsAsync(MutateRowsRequest) on the MutateRowsRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).
com.google.common.util.concurrent.ListenableFuture<List<MutateRowsResponse>>	mutateRowsAsync(MutateRowsRequest request) Performs a BigtableDataClient.mutateRowsAsync(MutateRowsRequest) on the MutateRowsRequest.
com.google.common.util.concurrent.ListenableFuture<List<FlatRow>>	readFlatRowsAsync(ReadRowsRequest request) Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest.
com.google.common.util.concurrent.ListenableFuture<ReadModifyWriteRowResponse>	readModifyWriteRowAsync(ReadModifyWriteRowRequest request) Performs a BigtableDataClient.readModifyWriteRow(ReadModifyWriteRowRequest) on the ReadModifyWriteRowRequest.
com.google.common.util.concurrent.ListenableFuture<ReadModifyWriteRowResponse>	readModifyWriteRowAsync(ReadModifyWriteRowRequest request, long operationId) Performs a BigtableDataClient.readModifyWriteRowAsync(ReadModifyWriteRowRequest) on the ReadModifyWriteRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).
com.google.common.util.concurrent.ListenableFuture<List<Row>>	readRowsAsync(ReadRowsRequest request) Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest.
com.google.common.util.concurrent.ListenableFuture<List<Row>>	readRowsAsync(ReadRowsRequest request, long operationId) Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constant LOG

MUTATE_ROW_ASYNC

protected static AsyncExecutor.AsyncCall<MutateRowRequest,MutateRowResponse> MUTATE_ROW_ASYNC

Calls BigtableDataClient.mutateRowAsync(MutateRowRequest).

MUTATE_ROWS_ASYNC

protected static AsyncExecutor.AsyncCall<MutateRowsRequest,List<MutateRowsResponse>> MUTATE_ROWS_ASYNC

Calls BigtableDataClient.mutateRowsAsync(MutateRowsRequest).

READ_MODIFY_WRITE_ASYNC

protected static AsyncExecutor.AsyncCall<ReadModifyWriteRowRequest,ReadModifyWriteRowResponse> READ_MODIFY_WRITE_ASYNC

Calls BigtableDataClient.readModifyWriteRowAsync(ReadModifyWriteRowRequest).

CHECK_AND_MUTATE_ASYNC

protected static AsyncExecutor.AsyncCall<CheckAndMutateRowRequest,CheckAndMutateRowResponse> CHECK_AND_MUTATE_ASYNC

Calls BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest).

READ_ROWS_ASYNC

protected static AsyncExecutor.AsyncCall<ReadRowsRequest,List<Row>> READ_ROWS_ASYNC

Calls BigtableDataClient.readRowsAsync(ReadRowsRequest).

READ_FLAT_ROWS_ASYNC

protected static AsyncExecutor.AsyncCall<ReadRowsRequest,List<FlatRow>> READ_FLAT_ROWS_ASYNC

Calls BigtableDataClient.readRowsAsync(ReadRowsRequest).

Constructor Detail

AsyncExecutor

public AsyncExecutor(BigtableDataClient client,
                     RpcThrottler rpcThrottler)

Constructor for AsyncExecutor.

Parameters:

client - a BigtableDataClient object.

rpcThrottler - a RpcThrottler object.

Method Detail

mutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<MutateRowResponse> mutateRowAsync(MutateRowRequest request,
                                                                                            long operationId)

Performs a BigtableDataClient.mutateRowAsync(MutateRowRequest) on the MutateRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Parameters:

request - The MutateRowRequest to send.

operationId - The Id generated from RpcThrottler.registerOperationWithHeapSize(long) that will be released when the mutate operation is completed.

Returns:

a ListenableFuture which can be listened to for completion events.

mutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<List<MutateRowsResponse>> mutateRowAsync(MutateRowsRequest request,
                                                                                                   long operationId)

Performs a BigtableDataClient.mutateRowsAsync(MutateRowsRequest) on the MutateRowsRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Parameters:

request - The MutateRowsRequest to send.

operationId - The Id generated from RpcThrottler.registerOperationWithHeapSize(long) that will be released when the mutate operation is completed.

Returns:

a ListenableFuture which can be listened to for completion events.

checkAndMutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<CheckAndMutateRowResponse> checkAndMutateRowAsync(CheckAndMutateRowRequest request,
                                                                                                            long operationId)

Performs a BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest) on the CheckAndMutateRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Parameters:

request - The CheckAndMutateRowRequest to send.

operationId - The Id generated from RpcThrottler.registerOperationWithHeapSize(long) that will be released when the checkAndMutateRow operation is completed.

Returns:

a ListenableFuture which can be listened to for completion events.

readModifyWriteRowAsync

public com.google.common.util.concurrent.ListenableFuture<ReadModifyWriteRowResponse> readModifyWriteRowAsync(ReadModifyWriteRowRequest request,
                                                                                                              long operationId)

Performs a BigtableDataClient.readModifyWriteRowAsync(ReadModifyWriteRowRequest) on the ReadModifyWriteRowRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Parameters:

request - The ReadModifyWriteRowRequest to send.

operationId - The Id generated from RpcThrottler.registerOperationWithHeapSize(long) that will be released when the readModifyWriteRowAsync operation is completed.

Returns:

a ListenableFuture which can be listened to for completion events.

readRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<Row>> readRowsAsync(ReadRowsRequest request,
                                                                                   long operationId)

Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest given an operationId generated from RpcThrottler.registerOperationWithHeapSize(long).

Parameters:

request - The ReadRowsRequest to send.

operationId - a long.

Returns:

a ListenableFuture which can be listened to for completion events.

mutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<MutateRowResponse> mutateRowAsync(MutateRowRequest request)
                                                                                     throws InterruptedException

Performs a BigtableDataClient.mutateRowAsync(MutateRowRequest) on the MutateRowRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The MutateRowRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

mutateRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<MutateRowsResponse>> mutateRowsAsync(MutateRowsRequest request)
                                                                                             throws InterruptedException

Performs a BigtableDataClient.mutateRowsAsync(MutateRowsRequest) on the MutateRowsRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The MutateRowRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

checkAndMutateRowAsync

public com.google.common.util.concurrent.ListenableFuture<CheckAndMutateRowResponse> checkAndMutateRowAsync(CheckAndMutateRowRequest request)
                                                                                                     throws InterruptedException

Performs a BigtableDataClient.checkAndMutateRowAsync(CheckAndMutateRowRequest) on the CheckAndMutateRowRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The CheckAndMutateRowRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

readModifyWriteRowAsync

public com.google.common.util.concurrent.ListenableFuture<ReadModifyWriteRowResponse> readModifyWriteRowAsync(ReadModifyWriteRowRequest request)
                                                                                                       throws InterruptedException

Performs a BigtableDataClient.readModifyWriteRow(ReadModifyWriteRowRequest) on the ReadModifyWriteRowRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The ReadModifyWriteRowRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

readRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<Row>> readRowsAsync(ReadRowsRequest request)
                                                                            throws InterruptedException

Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The ReadRowsRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

readFlatRowsAsync

public com.google.common.util.concurrent.ListenableFuture<List<FlatRow>> readFlatRowsAsync(ReadRowsRequest request)
                                                                                    throws InterruptedException

Performs a BigtableDataClient.readRowsAsync(ReadRowsRequest) on the ReadRowsRequest. This method may block if RpcThrottler.registerOperationWithHeapSize(long) blocks.

Parameters:

request - The ReadRowsRequest to send.

Returns:

a ListenableFuture which can be listened to for completion events.

Throws:

InterruptedException - if any.

flush

public void flush()
           throws IOException

Waits until all operations managed by the RpcThrottler complete. See RpcThrottler.awaitCompletion() for more information.

Throws:

IOException - if something goes wrong.

hasInflightRequests

public boolean hasInflightRequests()

hasInflightRequests.

Returns:

a boolean.

getMaxHeapSize

public long getMaxHeapSize()

getMaxHeapSize.

Returns:

a long.

getClient

public BigtableDataClient getClient()

Getter for the field client.

Returns:

a BigtableDataClient object.

getRpcThrottler

public RpcThrottler getRpcThrottler()

Getter for the field rpcThrottler.

Returns:

a RpcThrottler object.