com.google.cloud.bigtable.grpc.scanner

Class RetryingReadRowsOperation

java.lang.Object

io.grpc.ClientCall.Listener<ResponseT>

com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

com.google.cloud.bigtable.grpc.scanner.RetryingReadRowsOperation

All Implemented Interfaces:

ScanHandler

@NotThreadSafe
public class RetryingReadRowsOperation
extends AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>
implements ScanHandler

An extension of AbstractRetryingOperation that manages retries for the readRows streaming RPC. This class will keep track of the last returned row key via ReadRowsRequestManager and automatically retry from the last row key .

Author:

sduskis

Nested Class Summary

Nested classes/interfaces inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

AbstractRetryingOperation.GrpcFuture<RespT>

Field Summary

Fields inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

call, callLock, completionFuture, currentBackoff, failedCount, LOG, operationSpan, operationTimerContext, retryExecutorService, retryOptions, rpc, rpcTimerContext, UNARY_DEADLINE_MINUTES

Constructor Summary

Constructors

Constructor and Description
RetryingReadRowsOperation(io.grpc.stub.StreamObserver<FlatRow> observer, RetryOptions retryOptions, com.google.bigtable.v2.ReadRowsRequest request, BigtableAsyncRpc<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse> retryableRpc, io.grpc.CallOptions callOptions, ScheduledExecutorService retryExecutorService, io.grpc.Metadata originalMetadata)

Method Summary

Modifier and Type	Method and Description
protected void	finalizeStats(io.grpc.Status status)
protected com.google.bigtable.v2.ReadRowsRequest	getRetryRequest() Updates the original request via ReadRowsRequestManager.buildUpdatedRequest().
void	handleTimeout(ScanTimeoutException rte) This gets called by ResumingStreamingResultScanner when a queue is empty via ResponseQueueReader.getNext().
protected boolean	isRequestRetryable() All read rows requests are retryable.
void	onClose(io.grpc.Status status, io.grpc.Metadata trailers)
void	onMessage(com.google.bigtable.v2.ReadRowsResponse message)
protected boolean	onOK(io.grpc.Metadata trailers) A subclass has the opportunity to perform the final operations it needs now that the RPC is successfully complete.
protected void	performRetry(long nextBackOff)
void	run() Calls BigtableAsyncRpc.newCall(CallOptions) and BigtableAsyncRpc.start(Object, io.grpc.ClientCall.Listener, Metadata, ClientCall) } with this as the listener so that retries happen correctly.
void	setException(Exception exception)
void	setResultObserver(io.grpc.stub.StreamObserver<com.google.bigtable.v2.ReadRowsResponse> resultObserver)

Methods inherited from class com.google.cloud.bigtable.grpc.async.AbstractRetryingOperation

cancel, cancel, getAsyncResult, getBlockingResult, getCallOptions, getExhaustedRetriesException, getNextBackoff, getOriginalRequest, getRunnable, onError

Methods inherited from class io.grpc.ClientCall.Listener

onHeaders, onReady

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.bigtable.grpc.scanner.ScanHandler

cancel

Constructor Detail

RetryingReadRowsOperation

public RetryingReadRowsOperation(io.grpc.stub.StreamObserver<FlatRow> observer,
                                 RetryOptions retryOptions,
                                 com.google.bigtable.v2.ReadRowsRequest request,
                                 BigtableAsyncRpc<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse> retryableRpc,
                                 io.grpc.CallOptions callOptions,
                                 ScheduledExecutorService retryExecutorService,
                                 io.grpc.Metadata originalMetadata)

Method Detail

setResultObserver

public void setResultObserver(io.grpc.stub.StreamObserver<com.google.bigtable.v2.ReadRowsResponse> resultObserver)

getRetryRequest

protected com.google.bigtable.v2.ReadRowsRequest getRetryRequest()

Updates the original request via ReadRowsRequestManager.buildUpdatedRequest().

Overrides:

getRetryRequest in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

run

public void run()

Description copied from class: AbstractRetryingOperation

Calls BigtableAsyncRpc.newCall(CallOptions) and BigtableAsyncRpc.start(Object, io.grpc.ClientCall.Listener, Metadata, ClientCall) } with this as the listener so that retries happen correctly.

Overrides:

run in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

onMessage

public void onMessage(com.google.bigtable.v2.ReadRowsResponse message)

Overrides:

onMessage in class io.grpc.ClientCall.Listener<com.google.bigtable.v2.ReadRowsResponse>

finalizeStats

protected void finalizeStats(io.grpc.Status status)

Overrides:

finalizeStats in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

onClose

public void onClose(io.grpc.Status status,
                    io.grpc.Metadata trailers)

Overrides:

onClose in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

setException

public void setException(Exception exception)

Overrides:

setException in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

isRequestRetryable

protected boolean isRequestRetryable()

All read rows requests are retryable.

Overrides:

isRequestRetryable in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

onOK

protected boolean onOK(io.grpc.Metadata trailers)

A subclass has the opportunity to perform the final operations it needs now that the RPC is successfully complete. If a subclass has to retry, due to the message, this method will return false

Specified by:

onOK in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>

Returns:

true if the operation was really completed.

handleTimeout

public void handleTimeout(ScanTimeoutException rte)
                   throws BigtableRetriesExhaustedException

This gets called by ResumingStreamingResultScanner when a queue is empty via ResponseQueueReader.getNext().

Specified by:

handleTimeout in interface ScanHandler

Parameters:

rte - a ScanTimeoutException

Throws:

BigtableRetriesExhaustedException

performRetry

protected void performRetry(long nextBackOff)

Overrides:

performRetry in class AbstractRetryingOperation<com.google.bigtable.v2.ReadRowsRequest,com.google.bigtable.v2.ReadRowsResponse,String>