org.cloudfoundry.doppler

Class ValueMetric

java.lang.Object

org.cloudfoundry.doppler.ValueMetric

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ValueMetric
extends Object

Indicates the value of a metric at an instant in time

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValueMetric.Builder Builds instances of type ValueMetric.

Method Summary

Modifier and Type	Method and Description
static ValueMetric.Builder	builder() Creates a builder for ValueMetric.
boolean	equals(Object another) This instance is equal to all instances of ValueMetric that have equal attribute values.
static ValueMetric	from(org.cloudfoundry.dropsonde.events.ValueMetric dropsonde)
String	getName() The name of the metric.
String	getUnit() The unit of the metric.
int	hashCode() Computes a hash code from attributes: name, unit, value.
String	toString() Prints the immutable value ValueMetric with attribute values.
Double	value() The value at the time of event emission

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

The name of the metric. Must be consistent for downstream consumers to associate events semantically.

getUnit

public String getUnit()

The unit of the metric. Please see http://metrics20.org/spec/#units for ideas; SI units/prefixes are recommended where applicable. Should be consistent for the life of the metric (consumers are expected to report, but not interpret, prefixes).

value

public Double value()

The value at the time of event emission

equals

public boolean equals(Object another)

This instance is equal to all instances of ValueMetric that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: name, unit, value.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ValueMetric with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static ValueMetric.Builder builder()

Creates a builder for ValueMetric.

 ValueMetric.builder()
    .name(String) // required name
    .unit(String) // required unit
    .value(Double) // required value
    .build();
 

Returns:

A new ValueMetric builder

from

public static ValueMetric from(org.cloudfoundry.dropsonde.events.ValueMetric dropsonde)