com.hp.sdn.metric

Class RatioGaugeDescriptor.RatioGaugeDescriptorBuilder

java.lang.Object

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

com.hp.sdn.metric.RatioGaugeDescriptor.RatioGaugeDescriptorBuilder

Enclosing class:

RatioGaugeDescriptor

public static class RatioGaugeDescriptor.RatioGaugeDescriptorBuilder
extends MetricDescriptor.MetricDescriptorBuilder<RatioGaugeDescriptor>

Ratio gauge descriptor builder object, which requires that only arguments that are mandatory for the construction of a RatioGaugeDescriptor be specified during its own construction. Values may also be specified for the optional arguments needed for a RatioGaugeDescriptor, 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
RatioGaugeDescriptor.RatioGaugeDescriptorBuilder(String name) Creates a new RatioGaugeDescriptor.RatioGaugeDescriptorBuilder using only the arguments that are required to build a valid RatioGaugeDescriptor.

Method Summary

Methods

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

RatioGaugeDescriptor.RatioGaugeDescriptorBuilder

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder(String name)

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

Parameters:

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

Method Detail

build

public RatioGaugeDescriptor build()

Build a RatioGaugeDescriptor instance.

Specified by:

build in class MetricDescriptor.MetricDescriptorBuilder<RatioGaugeDescriptor>

Returns:

the resulting RatioGaugeDescriptor

appId

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - application ID

Returns:

self

description

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - description

Returns:

self

name

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - name

Returns:

self

persist

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - persistence flag

Returns:

self

primaryTag

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - primary tag

Returns:

self

publishToJmx

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - JMX flag

Returns:

self

secondaryTag

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - secondary tag

Returns:

self

summaryMinutes

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - summarization interval (in minutes)

Returns:

self

type

public RatioGaugeDescriptor.RatioGaugeDescriptorBuilder 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<RatioGaugeDescriptor>

Parameters:

toSet - metric type

Returns:

self