org.cloudfoundry.doppler

Class CounterEvent

java.lang.Object

org.cloudfoundry.doppler.CounterEvent

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

Represents the increment of a counter. It contains only the change in the value; it is the responsibility of downstream consumers to maintain the value of the counter.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CounterEvent.Builder	builder() Creates a builder for CounterEvent.
boolean	equals(Object another) This instance is equal to all instances of CounterEvent that have equal attribute values.
static CounterEvent	from(org.cloudfoundry.dropsonde.events.CounterEvent dropsonde)
Long	getDelta() The amount by which to increment the counter
String	getName() The name of the counter.
Long	getTotal() The total value of the counter.
int	hashCode() Computes a hash code from attributes: delta, name, total.
String	toString() Prints the immutable value CounterEvent with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

getDelta

public Long getDelta()

The amount by which to increment the counter

getName

public String getName()

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

getTotal

public Long getTotal()

The total value of the counter. This will be overridden by Metron, which internally tracks the total of each named Counter it receives.

equals

public boolean equals(Object another)

This instance is equal to all instances of CounterEvent 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: delta, name, total.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value CounterEvent with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static CounterEvent.Builder builder()

Creates a builder for CounterEvent.

 CounterEvent.builder()
    .delta(Long) // required delta
    .name(String) // required name
    .total(Long | null) // nullable total
    .build();
 

Returns:

A new CounterEvent builder

from

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