org.apache.beam.sdk.io.gcp.bigtable.changestreams.estimator

Interface ThroughputEstimator<T>

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BytesThroughputEstimator, NullThroughputEstimator

@Internal
public interface ThroughputEstimator<T>
extends java.io.Serializable

An estimator to calculate the throughput of the outputted elements from a DoFn.

Method Summary

Modifier and Type	Method and Description
default double	get() Returns the estimated throughput for now.
double	getFrom(org.joda.time.Instant time) Returns the estimated throughput for a specified time.
void	update(org.joda.time.Instant timeOfRecords, T element) Updates the estimator with the size of the records.

Method Detail

update

void update(org.joda.time.Instant timeOfRecords,
            T element)

Updates the estimator with the size of the records.

Parameters:

timeOfRecords - the committed timestamp of the records

element - the element to estimate the byte size of

get

default double get()

Returns the estimated throughput for now.

getFrom

double getFrom(org.joda.time.Instant time)

Returns the estimated throughput for a specified time.

Parameters:

time - the specified timestamp to check throughput