org.apache.hadoop.hbase.client

Interface ScanResultConsumer

@InterfaceAudience.Public
public interface ScanResultConsumer

Receives Result for an asynchronous scan.

Method Summary

Modifier and Type	Method and Description
void	onComplete() Indicate that the scan operation is completed normally.
void	onError(Throwable error) Indicate that we hit an unrecoverable error and the scan operation is terminated.
boolean	onNext(Result result)
default void	onScanMetricsCreated(ScanMetrics scanMetrics) If scan.isScanMetricsEnabled() returns true, then this method will be called prior to all other methods in this interface to give you the ScanMetrics instance for this scan operation.

Method Detail

onNext

boolean onNext(Result result)

Parameters:

result - the data fetched from HBase service.

Returns:

false if you want to terminate the scan process. Otherwise true

onError

void onError(Throwable error)

Indicate that we hit an unrecoverable error and the scan operation is terminated.

We will not call onComplete() after calling onError(Throwable).

onComplete

void onComplete()

Indicate that the scan operation is completed normally.

onScanMetricsCreated

default void onScanMetricsCreated(ScanMetrics scanMetrics)

If scan.isScanMetricsEnabled() returns true, then this method will be called prior to all other methods in this interface to give you the ScanMetrics instance for this scan operation. The ScanMetrics instance will be updated on-the-fly during the scan, you can store it somewhere to get the metrics at any time if you want.