org.springframework.xd.rest.domain.metrics

Class RichGaugeResource

java.lang.Object

org.springframework.hateoas.ResourceSupport

org.springframework.xd.rest.domain.NamedResource

org.springframework.xd.rest.domain.metrics.MetricResource

org.springframework.xd.rest.domain.metrics.RichGaugeResource

All Implemented Interfaces:

org.springframework.hateoas.Identifiable<org.springframework.hateoas.Link>

public class RichGaugeResource
extends MetricResource

The REST representation of a RichGauge.

Author:

Luke Taylor, Ilayaperumal Gopinathan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.xd.rest.domain.metrics.MetricResource

MetricResource.Page

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RichGaugeResource() No-arg constructor for serialization frameworks.
	RichGaugeResource(java.lang.String name, double value, double alpha, double average, double max, double min, long count)

Method Summary

Methods

Modifier and Type	Method and Description
double	getAlpha()
double	getAverage() Return the average value for the gauge.
long	getCount()
double	getMax()
double	getMin()
double	getValue() Return the value for the gauge.

Methods inherited from class org.springframework.xd.rest.domain.NamedResource

getName

Methods inherited from class org.springframework.hateoas.ResourceSupport

add, add, equals, getId, getLink, getLinks, hashCode, hasLink, hasLinks, removeLinks, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RichGaugeResource

protected RichGaugeResource()

No-arg constructor for serialization frameworks.

RichGaugeResource

public RichGaugeResource(java.lang.String name,
                 double value,
                 double alpha,
                 double average,
                 double max,
                 double min,
                 long count)

Method Detail

getValue

public double getValue()

Return the value for the gauge.

getAlpha

public double getAlpha()

getAverage

public double getAverage()

Return the average value for the gauge. This will be the arithmetic mean unless an 'alpha' value has been set for the gauge.

getMax

public double getMax()

getMin

public double getMin()

getCount

public long getCount()