com.google.cloud.bigtable.grpc.async

Class BulkMutation

java.lang.Object

com.google.cloud.bigtable.grpc.async.BulkMutation

public class BulkMutation
extends Object

This class combines a collection of MutateRowRequests into a single MutateRowsRequest. This class is not thread safe, and requires calling classes to make it thread safe.

Version:

$Id: $Id

Author:

sduskis

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG Constant LOG
static long	MAX_RPC_WAIT_TIME

Constructor Summary

Constructors

Constructor and Description
BulkMutation(BigtableTableName tableName, AsyncExecutor asyncExecutor, RetryOptions retryOptions, ScheduledExecutorService retryExecutorService, int maxRowKeyCount, long maxRequestSize) Constructor for BulkMutation.
BulkMutation(BigtableTableName tableName, AsyncExecutor asyncExecutor, RetryOptions retryOptions, ScheduledExecutorService retryExecutorService, int maxRowKeyCount, long maxRequestSize, long autoflushMs) Constructor for BulkMutation.

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<MutateRowResponse>	add(MutateRowRequest request)
com.google.common.util.concurrent.ListenableFuture<MutateRowResponse>	add(MutateRowsRequest.Entry entry) Adds a MutateRowsRequest.Entry to the MutateRowsRequest.Builder.
void	flush() Send any outstanding MutateRowRequests.
boolean	isFlushed()

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

MAX_RPC_WAIT_TIME

public static final long MAX_RPC_WAIT_TIME

Constructor Detail

BulkMutation

public BulkMutation(BigtableTableName tableName,
                    AsyncExecutor asyncExecutor,
                    RetryOptions retryOptions,
                    ScheduledExecutorService retryExecutorService,
                    int maxRowKeyCount,
                    long maxRequestSize)

Constructor for BulkMutation.

Parameters:

tableName - a BigtableTableName object for the table to which all MutateRowRequests will be sent.

asyncExecutor - a AsyncExecutor object that asynchronously sends MutateRowsRequest.

retryOptions - a RetryOptions object that describes how to perform retries.

retryExecutorService - a ScheduledExecutorService object on which to schedule retries.

maxRowKeyCount - describes the maximum number of MutateRowRequests to send in a single MutateRowsRequest.

maxRequestSize - describes the maximum cumulative size of a MutateRowsRequest.

BulkMutation

public BulkMutation(BigtableTableName tableName,
                    AsyncExecutor asyncExecutor,
                    RetryOptions retryOptions,
                    ScheduledExecutorService retryExecutorService,
                    int maxRowKeyCount,
                    long maxRequestSize,
                    long autoflushMs)

Constructor for BulkMutation.

Parameters:

tableName - a BigtableTableName object for the table to which all MutateRowRequests will be sent.

asyncExecutor - a AsyncExecutor object that asynchronously sends MutateRowsRequest.

retryOptions - a RetryOptions object that describes how to perform retries.

retryExecutorService - a ScheduledExecutorService object on which to schedule retries.

maxRowKeyCount - describes the maximum number of MutateRowRequests to send in a single MutateRowsRequest.

maxRequestSize - describes the maximum cumulative size of a MutateRowsRequest.

autoflushMs - the maximum number of milliseconds that items can linger before being flush. 0 to disable.

Method Detail

add

public com.google.common.util.concurrent.ListenableFuture<MutateRowResponse> add(MutateRowRequest request)

add

public com.google.common.util.concurrent.ListenableFuture<MutateRowResponse> add(MutateRowsRequest.Entry entry)

Adds a MutateRowsRequest.Entry to the MutateRowsRequest.Builder.

Parameters:

entry - The MutateRowsRequest.Entry to add

Returns:

a SettableFuture that will be populated when the MutateRowsResponse returns from the server. See BulkMutation.Batch.addCallback(ListenableFuture) for more information about how the SettableFuture is set.

flush

public void flush()

Send any outstanding MutateRowRequests.

isFlushed

public boolean isFlushed()

Returns:

false if there are any outstanding MutateRowRequest that still need to be sent.