org.cloudfoundry.doppler

Class Envelope

java.lang.Object

org.cloudfoundry.doppler.Envelope

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

Wraps an Event and adds metadata

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Envelope.Builder	builder() Creates a builder for Envelope.
boolean	equals(Object another) This instance is equal to all instances of Envelope that have equal attribute values.
static Envelope	from(org.cloudfoundry.dropsonde.events.Envelope dropsonde)
ContainerMetric	getContainerMetric() The enclosed ContainerMetric
CounterEvent	getCounterEvent() The enclosed CounterEvent
String	getDeployment() Deployment name (used to uniquely identify source)
Error	getError() The enclosed Error
EventType	getEventType() Type of wrapped event.
HttpStartStop	getHttpStartStop() The enclosed HttpStartStop
String	getIndex() Index of job (used to uniquely identify source)
String	getIp() IP address (used to uniquely identify source)
String	getJob() Job name (used to uniquely identify source)
LogMessage	getLogMessage() The enclosed LogMessage
String	getOrigin() Unique description of the origin of this event
Map<String,String>	getTags() key/value tags to include additional identifying information
Long	getTimestamp() UNIX timestamp (in nanoseconds) event was wrapped in this Envelope.
ValueMetric	getValueMetric() The enclosed ValueMetric
int	hashCode() Computes a hash code from attributes: containerMetric, counterEvent, deployment, error, eventType, httpStartStop, index, ip, job, logMessage, origin, tags, timestamp, valueMetric.
String	toString() Prints the immutable value Envelope with attribute values.

Methods inherited from class java.lang.Object

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

Method Detail

getContainerMetric

public ContainerMetric getContainerMetric()

The enclosed ContainerMetric

getCounterEvent

public CounterEvent getCounterEvent()

The enclosed CounterEvent

getDeployment

public String getDeployment()

Deployment name (used to uniquely identify source)

getError

public Error getError()

The enclosed Error

getEventType

public EventType getEventType()

Type of wrapped event. Only the optional field corresponding to the value of eventType should be set.

getHttpStartStop

public HttpStartStop getHttpStartStop()

The enclosed HttpStartStop

getIndex

public String getIndex()

Index of job (used to uniquely identify source)

getIp

public String getIp()

IP address (used to uniquely identify source)

getJob

public String getJob()

Job name (used to uniquely identify source)

getLogMessage

public LogMessage getLogMessage()

The enclosed LogMessage

getOrigin

public String getOrigin()

Unique description of the origin of this event

getTags

public Map<String,String> getTags()

key/value tags to include additional identifying information

getTimestamp

public Long getTimestamp()

UNIX timestamp (in nanoseconds) event was wrapped in this Envelope.

getValueMetric

public ValueMetric getValueMetric()

The enclosed ValueMetric

equals

public boolean equals(Object another)

This instance is equal to all instances of Envelope 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: containerMetric, counterEvent, deployment, error, eventType, httpStartStop, index, ip, job, logMessage, origin, tags, timestamp, valueMetric.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Envelope with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

builder

public static Envelope.Builder builder()

Creates a builder for Envelope.

 Envelope.builder()
    .containerMetric(org.cloudfoundry.doppler.ContainerMetric | null) // nullable containerMetric
    .counterEvent(org.cloudfoundry.doppler.CounterEvent | null) // nullable counterEvent
    .deployment(String | null) // nullable deployment
    .error(Error | null) // nullable error
    .eventType(org.cloudfoundry.doppler.EventType) // required eventType
    .httpStartStop(org.cloudfoundry.doppler.HttpStartStop | null) // nullable httpStartStop
    .index(String | null) // nullable index
    .ip(String | null) // nullable ip
    .job(String | null) // nullable job
    .logMessage(org.cloudfoundry.doppler.LogMessage | null) // nullable logMessage
    .origin(String) // required origin
    .tag|putAllTags(String => String) // tags mappings
    .timestamp(Long | null) // nullable timestamp
    .valueMetric(org.cloudfoundry.doppler.ValueMetric | null) // nullable valueMetric
    .build();
 

Returns:

A new Envelope builder

from

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