org.dashbuilder.dataset.def

Interface KafkaDataSetDefBuilder<T extends DataSetDefBuilder>

All Superinterfaces:

DataSetDefBuilder<T>

All Known Implementing Classes:

KafkaDataSetDefBuilderImpl

public interface KafkaDataSetDefBuilder<T extends DataSetDefBuilder>
extends DataSetDefBuilder<T>

A builder for defining Kafka data sets.

    DataSetDef dataSetDef = DataSetDefFactory.newKafkaDataSetDef()
     .host("localhost")
     .port(9999)   
     .buildDef();
 

Method Summary

Modifier and Type	Method and Description
T	clientId(String clientId) Set the data set client Id
T	filter(String filter) Set the data set filter
T	host(String host) Set the data set kafka host
T	nodeId(String nodeId) Set the data set node id
T	partition(String partition) Set the data set partition
T	port(String port) Set the RMI port
T	target(KafkaDataSetDef.MetricsTarget target) Set the data set kafka metrics target
T	topic(String topic) Set the data set topic

Methods inherited from interface org.dashbuilder.dataset.def.DataSetDefBuilder

buildDef, cacheOff, cacheOn, column, date, label, name, number, pushOff, pushOn, refreshOff, refreshOn, text, uuid

Method Detail

host

T host(String host)

Set the data set kafka host

Parameters:

host - The Kafka server with JMX enabled where this data set should collect metrics from

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

port

T port(String port)

Set the RMI port

Parameters:

port - The Kafka RMI port

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

target

T target(KafkaDataSetDef.MetricsTarget target)

Set the data set kafka metrics target

Parameters:

host - The metrics target

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

clientId

T clientId(String clientId)

Set the data set client Id

Parameters:

clientId - Optional parameter to set a clientId to collect metrics

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

filter

T filter(String filter)

Set the data set filter

Parameters:

clientId - Optional parameter to set a clientId to collect metrics

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

nodeId

T nodeId(String nodeId)

Set the data set node id

Parameters:

nodeId - The node Id that can be used when collecting metrics

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

topic

T topic(String topic)

Set the data set topic

Parameters:

topic - The topic that will be used to collect metrics against it

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.

partition

T partition(String partition)

Set the data set partition

Parameters:

partition - The partition that can be used to collect certain types of metrics.

Returns:

The DataSetDefBuilder instance that is being used to configure a DataSetDef.