com.hp.sdn.metric

Class RollingCounterDescriptor.RollingCounterDescriptorBuilder

java.lang.Object

com.hp.sdn.metric.MetricDescriptor.MetricDescriptorBuilder<RollingCounterDescriptor>

com.hp.sdn.metric.RollingCounterDescriptor.RollingCounterDescriptorBuilder

Enclosing class:

RollingCounterDescriptor

public static class RollingCounterDescriptor.RollingCounterDescriptorBuilder
extends MetricDescriptor.MetricDescriptorBuilder<RollingCounterDescriptor>

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

Author:

Steve Britt

Field Summary

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

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
RollingCounterDescriptor.RollingCounterDescriptorBuilder	appId(String toSet) Sets the application ID to apply to the MetricDescriptor that will be built.
RollingCounterDescriptor	build() Build a RollingCounterDescriptor instance.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	description(String toSet) Sets the description to apply to the MetricDescriptor that will be built.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	name(String toSet) Sets the name to apply to the MetricDescriptor that will be built.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	persist(boolean toSet) Sets the flag that indicates whether the MetricDescriptor that will be built is to be persisted.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	primaryTag(String toSet) Sets the primary tag (e.g.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	primingValue(Long toSet) Sets the priming value to apply to the RollingCounterDescriptor that will be built.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	publishToJmx(boolean toSet) Sets the flag that indicates whether the MetricDescriptor that will be built should be made visible via JMX.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	secondaryTag(String toSet) Sets the secondary tag (e.g.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	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.
RollingCounterDescriptor.RollingCounterDescriptorBuilder	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

RollingCounterDescriptor.RollingCounterDescriptorBuilder

public RollingCounterDescriptor.RollingCounterDescriptorBuilder(String name)

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

Parameters:

name - a name for the TimeStampedRollingCounter (e.g. "txPackets")

Method Detail

build

public RollingCounterDescriptor build()

Build a RollingCounterDescriptor instance.

Specified by:

build in class MetricDescriptor.MetricDescriptorBuilder<RollingCounterDescriptor>

Returns:

the resulting RollingCounterDescriptor

appId

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - application ID

Returns:

self

description

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - description

Returns:

self

name

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - name

Returns:

self

persist

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - persistence flag

Returns:

self

primaryTag

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - primary tag

Returns:

self

primingValue

public RollingCounterDescriptor.RollingCounterDescriptorBuilder primingValue(Long toSet)

Sets the priming value to apply to the RollingCounterDescriptor that will be built. This is the value that will be used initially to compute a delta for the TimeStampedRollingCounter; if no value is provided then the first update of the TimeStampedRollingCounter will be used as a priming value.

Parameters:

toSet - priming value

Returns:

self

publishToJmx

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - JMX flag

Returns:

self

secondaryTag

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - secondary tag

Returns:

self

summaryMinutes

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - summarization interval (in minutes)

Returns:

self

type

public RollingCounterDescriptor.RollingCounterDescriptorBuilder 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<RollingCounterDescriptor>

Parameters:

toSet - metric type

Returns:

self