com.datastax.oss.dsbulk.executor.api.listener

Class AbstractMetricsReportingExecutionListenerBuilder<T extends AbstractMetricsReportingExecutionListener>

java.lang.Object

com.datastax.oss.dsbulk.executor.api.listener.AbstractMetricsReportingExecutionListenerBuilder<T>

Type Parameters:

T - the actual type that this builder builds.

public abstract class AbstractMetricsReportingExecutionListenerBuilder<T extends AbstractMetricsReportingExecutionListener>
extends Object

A builder for AbstractMetricsReportingExecutionListener.

Method Summary

Modifier and Type	Method and Description
abstract T	build() Builds a new instance of AbstractMetricsReportingExecutionListener.
AbstractMetricsReportingExecutionListenerBuilder<T>	convertDurationsTo(TimeUnit durationUnit) Convert durations to the given time unit.
AbstractMetricsReportingExecutionListenerBuilder<T>	convertRatesTo(TimeUnit rateUnit) Convert rates to the given time unit.
AbstractMetricsReportingExecutionListenerBuilder<T>	expectingTotalEvents(long expectedTotal) The total number of expected events.
AbstractMetricsReportingExecutionListenerBuilder<T>	extractingMetricsFrom(MetricsCollectingExecutionListener delegate) Instructs the new reporter to use the given delegate as is source of metrics.
AbstractMetricsReportingExecutionListenerBuilder<T>	withLogSink(LogSink sink) Use the given LogSink to log messages.
AbstractMetricsReportingExecutionListenerBuilder<T>	withScheduler(ScheduledExecutorService scheduler) Use the given scheduler to schedule periodic reports.

Methods inherited from class java.lang.Object

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

Method Detail

extractingMetricsFrom

public AbstractMetricsReportingExecutionListenerBuilder<T> extractingMetricsFrom(MetricsCollectingExecutionListener delegate)

Instructs the new reporter to use the given delegate as is source of metrics.

If this method is not called, a newly-allocated MetricsCollectingExecutionListener will be used.

Parameters:

delegate - the ReadsReportingExecutionListener to use as metrics source.

Returns:

this (for method chaining).

expectingTotalEvents

public AbstractMetricsReportingExecutionListenerBuilder<T> expectingTotalEvents(long expectedTotal)

The total number of expected events.

If this number is set, the reporter will also print a percentage of the overall progression.

Parameters:

expectedTotal - the total number of expected events.

Returns:

this (for method chaining)

convertRatesTo

public AbstractMetricsReportingExecutionListenerBuilder<T> convertRatesTo(TimeUnit rateUnit)

Convert rates to the given time unit.

Parameters:

rateUnit - a unit of time.

Returns:

this (for method chaining)

convertDurationsTo

public AbstractMetricsReportingExecutionListenerBuilder<T> convertDurationsTo(TimeUnit durationUnit)

Convert durations to the given time unit.

Parameters:

durationUnit - a unit of time.

Returns:

this (for method chaining)

withScheduler

public AbstractMetricsReportingExecutionListenerBuilder<T> withScheduler(ScheduledExecutorService scheduler)

Use the given scheduler to schedule periodic reports.

If this method is not called, a default scheduler is created.

Parameters:

scheduler - the scheduler to use.

Returns:

this (for method chaining)

withLogSink

public AbstractMetricsReportingExecutionListenerBuilder<T> withLogSink(LogSink sink)

Use the given LogSink to log messages.

If this method is not called, then a default log sink is used.

Parameters:

sink - the LogSink to use.

Returns:

this (for method chaining).

build

public abstract T build()

Builds a new instance of AbstractMetricsReportingExecutionListener.

Returns:

a new instance of AbstractMetricsReportingExecutionListener.