SplitParallelSampleBandwidthEstimator.Builder


class SplitParallelSampleBandwidthEstimator.Builder


A builder to create SplitParallelSampleBandwidthEstimator instances.

Summary

Public constructors

Creates a new builder instance.

Public functions

SplitParallelSampleBandwidthEstimator!
SplitParallelSampleBandwidthEstimator.Builder!

Sets the BandwidthStatistic to be used by the estimator.

SplitParallelSampleBandwidthEstimator.Builder!

Sets a minimum threshold of bytes that need to be transferred before the estimator can return a bandwidth estimate.

SplitParallelSampleBandwidthEstimator.Builder!

Sets a minimum threshold of samples that need to be taken before the estimator can return a bandwidth estimate.

Public constructors

Builder

Builder()

Creates a new builder instance.

Public functions

setBandwidthStatistic

@CanIgnoreReturnValue
fun setBandwidthStatistic(bandwidthStatistic: BandwidthStatistic!): SplitParallelSampleBandwidthEstimator.Builder!

Sets the BandwidthStatistic to be used by the estimator. By default, this is set to a SlidingWeightedAverageBandwidthStatistic.

Parameters
bandwidthStatistic: BandwidthStatistic!

The BandwidthStatistic.

Returns
SplitParallelSampleBandwidthEstimator.Builder!

This builder for convenience.

setMinBytesTransferred

@CanIgnoreReturnValue
fun setMinBytesTransferred(minBytesTransferred: Long): SplitParallelSampleBandwidthEstimator.Builder!

Sets a minimum threshold of bytes that need to be transferred before the estimator can return a bandwidth estimate. By default, this is set to 0.

Parameters
minBytesTransferred: Long

The minimum number of transferred bytes.

Returns
SplitParallelSampleBandwidthEstimator.Builder!

This builder for convenience.

setMinSamples

@CanIgnoreReturnValue
fun setMinSamples(minSamples: Int): SplitParallelSampleBandwidthEstimator.Builder!

Sets a minimum threshold of samples that need to be taken before the estimator can return a bandwidth estimate. By default, this is set to 0.

Parameters
minSamples: Int

The minimum number of samples.

Returns
SplitParallelSampleBandwidthEstimator.Builder!

This builder for convenience.