Package com.arpnetworking.tsdcore.sinks

Class KairosDbSink.Builder

java.lang.Object

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

com.arpnetworking.tsdcore.sinks.BaseSink.Builder<B,S>

com.arpnetworking.tsdcore.sinks.HttpPostSink.Builder<KairosDbSink.Builder,KairosDbSink>

com.arpnetworking.tsdcore.sinks.KairosDbSink.Builder

All Implemented Interfaces:

com.arpnetworking.commons.builder.Builder<KairosDbSink>

Enclosing class:

KairosDbSink

public static class KairosDbSink.Builder
extends HttpPostSink.Builder<KairosDbSink.Builder,KairosDbSink>

Implementation of builder pattern for KairosDbSink.

Author:

Ville Koskela (ville dot koskela at inscopemetrics dot com)

Constructor Summary

Constructors

Constructor	Description
Builder()	Public constructor.

Method Summary

Modifier and Type	Method	Description
protected KairosDbSink.Builder	self()	Called by setters to always return appropriate subclass of BaseSink.Builder, even from setters of base class.
KairosDbSink.Builder	setHistogramTtl(Duration value)	Sets the TTL of histograms.
KairosDbSink.Builder	setMaxRequestSize(Integer value)	Sets the maximum size of the request to publish.
KairosDbSink.Builder	setPublishHistograms(Boolean value)	Sets whether or not to publish full histograms.
KairosDbSink.Builder	setPublishStandardMetrics(Boolean value)	Sets whether or not to publish non-histogram metrics.
KairosDbSink.Builder	setTtl(Duration value)	Sets the TTL of non-histogram metrics.

Methods inherited from class com.arpnetworking.tsdcore.sinks.HttpPostSink.Builder

setAcceptedStatusCodes, setActorSystem, setBaseBackoff, setMaximumAttempts, setMaximumConcurrency, setMaximumDelay, setMaximumQueueSize, setPeriodicMetrics, setRetryableStatusCodes, setSpreadPeriod, setUri

Methods inherited from class com.arpnetworking.tsdcore.sinks.BaseSink.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

self

protected KairosDbSink.Builder self()

Description copied from class: BaseSink.Builder

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

Specified by:

self in class BaseSink.Builder<KairosDbSink.Builder,KairosDbSink>

Returns:

instance with correct BaseSink.Builder class type.

setMaxRequestSize

public KairosDbSink.Builder setMaxRequestSize(Integer value)

Sets the maximum size of the request to publish. Optional. Defaults to 100KiB.

Parameters:

value - the maximum request size.

Returns:

This instance of KairosDbSink.Builder.

setPublishStandardMetrics

public KairosDbSink.Builder setPublishStandardMetrics(Boolean value)

Sets whether or not to publish non-histogram metrics. Optional. Defaults to true.

Parameters:

value - true to publish standard metrics

Returns:

This instance of KairosDbSink.Builder.

setPublishHistograms

public KairosDbSink.Builder setPublishHistograms(Boolean value)

Sets whether or not to publish full histograms. Optional. Defaults to false.

Parameters:

value - true to publish histograms

Returns:

This instance of KairosDbSink.Builder.

setTtl

public KairosDbSink.Builder setTtl(Duration value)

Sets the TTL of non-histogram metrics. NOTE: A value of 0 represents permanent. Optional. Defaults to permanent.

Parameters:

value - the time to retain histograms

Returns:

This instance of KairosDbSink.Builder.

setHistogramTtl

public KairosDbSink.Builder setHistogramTtl(Duration value)

Sets the TTL of histograms. NOTE: A value of 0 represents permanent. Optional. Defaults to permanent.

Parameters:

value - the time to retain histograms

Returns:

This instance of KairosDbSink.Builder.