com.h3c.sdn.metric

Class MeterDescriptor.MeterDescriptorBuilder

java.lang.Object

com.h3c.sdn.metric.MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

com.h3c.sdn.metric.MeterDescriptor.MeterDescriptorBuilder

Enclosing class:

MeterDescriptor

public static class MeterDescriptor.MeterDescriptorBuilder
extends MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Meter descriptor builder object, which requires that only arguments that are mandatory for the construction of a MeterDescriptor be specified during its own construction. Values may also be specified for the optional arguments needed for a MeterDescriptor, but these values are defaulted in the event that no value is specified for them.

Field Summary

Fields inherited from class com.h3c.sdn.metric.MetricDescriptor.MetricDescriptorBuilder

appId, description, jmx, name, persist, primaryTag, secondaryTag, summaryMinutes, type

Constructor Summary

Constructors

Constructor and Description
MeterDescriptor.MeterDescriptorBuilder(String name) Creates a new MeterDescriptor.MeterDescriptorBuilder using only the arguments that are required to build a valid MeterDescriptor.

Method Summary

Methods

Modifier and Type	Method and Description
MeterDescriptor.MeterDescriptorBuilder	appId(String toSet) Sets the application ID to apply to the MetricDescriptor that will be built.
MeterDescriptor	build() Build a MeterDescriptor instance.
MeterDescriptor.MeterDescriptorBuilder	description(String toSet) Sets the description to apply to the MetricDescriptor that will be built.
MeterDescriptor.MeterDescriptorBuilder	name(String toSet) Sets the name to apply to the MetricDescriptor that will be built.
MeterDescriptor.MeterDescriptorBuilder	persist(boolean toSet) Sets the flag that indicates whether the MetricDescriptor that will be built is to be persisted.
MeterDescriptor.MeterDescriptorBuilder	primaryTag(String toSet) Sets the primary tag (e.g.
MeterDescriptor.MeterDescriptorBuilder	publishToJmx(boolean toSet) Sets the flag that indicates whether the MetricDescriptor that will be built should be made visible via JMX.
MeterDescriptor.MeterDescriptorBuilder	secondaryTag(String toSet) Sets the secondary tag (e.g.
MeterDescriptor.MeterDescriptorBuilder	summaryMinutes(MetricDescriptor.SummaryIntervalMinutes toSet) Sets the number of minutes that should elapse between the persistence of summarized values to apply to the MetricDescriptor that will be built.
MeterDescriptor.MeterDescriptorBuilder	type(MetricDescriptor.Type toSet) Sets the metric type to apply to the MetricDescriptor that will be built.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeterDescriptor.MeterDescriptorBuilder

public MeterDescriptor.MeterDescriptorBuilder(String name)

Creates a new MeterDescriptor.MeterDescriptorBuilder using only the arguments that are required to build a valid MeterDescriptor. If no other fields are set via other methods before building, the resulting MeterDescriptor will specify a TimeStampedMeter associated with no specific application, no primary or secondary tags, no description, and that the resulting TimeStampedMeter should be persisted using the default summarization interval and should not be visible via JMX.

Parameters:

name - a name for the TimeStampedMeter (e.g. "txPacketRate")

Method Detail

build

public MeterDescriptor build()

Build a MeterDescriptor instance.

Specified by:

build in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Returns:

the resulting MeterDescriptor

appId

public MeterDescriptor.MeterDescriptorBuilder appId(String toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the application ID to apply to the MetricDescriptor that will be built.

Overrides:

appId in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - application ID

Returns:

self

description

public MeterDescriptor.MeterDescriptorBuilder description(String toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the description to apply to the MetricDescriptor that will be built.

Overrides:

description in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - description

Returns:

self

name

public MeterDescriptor.MeterDescriptorBuilder name(String toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the name to apply to the MetricDescriptor that will be built. Many metrics may have the same name (e.g. "txPackets") but can be distinguished from one another via the primary and secondary tags specified.

Overrides:

name in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - name

Returns:

self

persist

public MeterDescriptor.MeterDescriptorBuilder persist(boolean toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the flag that indicates whether the MetricDescriptor that will be built is to be persisted. true indicates that the value should be persisted, false that it shouldn't.

Overrides:

persist in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - persistence flag

Returns:

self

primaryTag

public MeterDescriptor.MeterDescriptorBuilder primaryTag(String toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the primary tag (e.g. "router-1.2.3.4") to apply to the MetricDescriptor that will be built. The tag can be anything that is a useful identifier to group metrics by.

Overrides:

primaryTag in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - primary tag

Returns:

self

publishToJmx

public MeterDescriptor.MeterDescriptorBuilder publishToJmx(boolean toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the flag that indicates whether the MetricDescriptor that will be built should be made visible via JMX. true indicates that the value should be visible, false that it shouldn't.

Overrides:

publishToJmx in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - JMX flag

Returns:

self

secondaryTag

public MeterDescriptor.MeterDescriptorBuilder secondaryTag(String toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the secondary tag (e.g. "port1") to apply to the MetricDescriptor that will be built. The tag can be anything that is a useful identifier to group metrics by, but should make sense in the context of the specified primary tag.

Overrides:

secondaryTag in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - secondary tag

Returns:

self

summaryMinutes

public MeterDescriptor.MeterDescriptorBuilder summaryMinutes(MetricDescriptor.SummaryIntervalMinutes toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the number of minutes that should elapse between the persistence of summarized values to apply to the MetricDescriptor that will be built.

Overrides:

summaryMinutes in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - summarization interval (in minutes)

Returns:

self

type

public MeterDescriptor.MeterDescriptorBuilder type(MetricDescriptor.Type toSet)

Description copied from class: MetricDescriptor.MetricDescriptorBuilder

Sets the metric type to apply to the MetricDescriptor that will be built.

Overrides:

type in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>

Parameters:

toSet - metric type

Returns:

self