Package com.arpnetworking.metrics.common.sources

Class KafkaSource.Builder<V>

java.lang.Object

com.arpnetworking.commons.builder.OvalBuilder<S>

com.arpnetworking.metrics.common.sources.BaseSource.Builder<KafkaSource.Builder<V>,KafkaSource<V>>

com.arpnetworking.metrics.common.sources.KafkaSource.Builder<V>

Type Parameters:

V - the type of data of value in kafka ConsumerRecords

All Implemented Interfaces:

com.arpnetworking.commons.builder.Builder<KafkaSource<V>>

Enclosing class:

KafkaSource<V>

public static final class KafkaSource.Builder<V>
extends BaseSource.Builder<KafkaSource.Builder<V>,KafkaSource<V>>

Builder pattern class for KafkaSource.

Author:

Joey Jackson (jjackson at dropbox dot com)

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
protected KafkaSource.Builder<V>	self()	Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.
KafkaSource.Builder<V>	setBackoffTime(Duration backoffTime)	Sets the amount of time the KafkaSource will wait to retry an operation after receiving an exception.
KafkaSource.Builder<V>	setBufferSize(Integer bufferSize)	Sets the size of the buffer to hold ConsumerRecords from the Consumer before they are parsed.
KafkaSource.Builder<V>	setConsumer(org.apache.kafka.clients.consumer.Consumer<?,V> consumer)	Sets Consumer.
KafkaSource.Builder<V>	setNumWorkerThreads(Integer numWorkerThreads)	Sets the number of threads that will parse ConsumerRecords from the Consumer.
KafkaSource.Builder<V>	setParser(Parser<List<Record>,V> value)	Sets Parser.
KafkaSource.Builder<V>	setPeriodicMetrics(com.arpnetworking.metrics.incubator.PeriodicMetrics periodicMetrics)	Sets PeriodicMetrics for instrumentation of KafkaSource.
KafkaSource.Builder<V>	setPollTime(Duration pollTime)	Sets the duration the consumer will poll kafka for each consume.
KafkaSource.Builder<V>	setShutdownAwaitTime(Duration shutdownAwaitTime)	Sets the amount of time the KafkaSource will wait to shutdown the RunnableConsumer thread.

Methods inherited from class com.arpnetworking.metrics.common.sources.BaseSource.Builder

setName

Methods inherited from class com.arpnetworking.commons.builder.OvalBuilder

build, clone, clone, construct, isSelfValidating, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Public constructor.

Method Details

setConsumer

public KafkaSource.Builder<V> setConsumer(org.apache.kafka.clients.consumer.Consumer<?,V> consumer)

Sets Consumer. Cannot be null.

Parameters:

consumer - The Consumer.

Returns:

This instance of KafkaSource.Builder.

setParser

public KafkaSource.Builder<V> setParser(Parser<List<Record>,V> value)

Sets Parser. Cannot be null.

Parameters:

value - The Parser.

Returns:

This instance of KafkaSource.Builder.

setPollTime

public KafkaSource.Builder<V> setPollTime(Duration pollTime)

Sets the duration the consumer will poll kafka for each consume. Cannot be null or negative.

Parameters:

pollTime - The Duration of each poll call made by the KafkaConsumer.

Returns:

This instance of KafkaSource.Builder.

setShutdownAwaitTime

public KafkaSource.Builder<V> setShutdownAwaitTime(Duration shutdownAwaitTime)

Sets the amount of time the KafkaSource will wait to shutdown the RunnableConsumer thread. Default is 10 seconds. Cannot be null or negative.

Parameters:

shutdownAwaitTime - The Duration the KafkaSource will wait to shutdown the RunnableConsumer thread.

Returns:

This instance of KafkaSource.Builder.

setBackoffTime

public KafkaSource.Builder<V> setBackoffTime(Duration backoffTime)

Sets the amount of time the KafkaSource will wait to retry an operation after receiving an exception. Default is 1 second. Cannot be null or negative.

Parameters:

backoffTime - The Duration the KafkaSource will wait to retry an operation on exception.

Returns:

This instance of KafkaSource.Builder.

setNumWorkerThreads

public KafkaSource.Builder<V> setNumWorkerThreads(Integer numWorkerThreads)

Sets the number of threads that will parse ConsumerRecords from the Consumer. Default is 1. Must be greater than or equal to 1.

Parameters:

numWorkerThreads - The number of parsing worker threads.

Returns:

This instance of KafkaSource.Builder.

setBufferSize

public KafkaSource.Builder<V> setBufferSize(Integer bufferSize)

Sets the size of the buffer to hold ConsumerRecords from the Consumer before they are parsed. Default is 1000. Must be greater than or equal to 1.

Parameters:

bufferSize - The size of the buffer.

Returns:

This instance of KafkaSource.Builder.

setPeriodicMetrics

public KafkaSource.Builder<V> setPeriodicMetrics(com.arpnetworking.metrics.incubator.PeriodicMetrics periodicMetrics)

Sets PeriodicMetrics for instrumentation of KafkaSource.

Parameters:

periodicMetrics - The PeriodicMetrics for the KafkaSource.

Returns:

This instance of KafkaSource.Builder.

self

protected KafkaSource.Builder<V> self()

Description copied from class: BaseSource.Builder

Called by setters to always return appropriate subclass of BaseSource.Builder, even from setters of base class.

Specified by:

self in class BaseSource.Builder<KafkaSource.Builder<V>,KafkaSource<V>>

Returns:

instance with correct BaseSource.Builder class type.