Package io.honeycomb.libhoney

Class Event

java.lang.Object

io.honeycomb.libhoney.eventdata.EventData<Event>

io.honeycomb.libhoney.Event

public class Event
extends EventData<Event>

An Event holds data to be sent to Honeycomb. It also specifies configuration settings (e.g. sampleRate) relevant to the send operation. Properties defined on the Event override the same ones it received from either EventFactory or LibHoney. See HoneyClient's class documentation for the "Event Validation" rules, and further descriptions exist on the Options and LibHoney classes.

The metadata that can be set on Event is not sent to Honeycomb. It will be passed back to any registered ResponseObservers and may be useful for clients that implement response handling and want to, for instance, match up the Response with the original source of an Event.

This class is mutable and not threadsafe.

Method Summary

Modifier and Type	Method	Description
protected Event	getSelf()
void	send()	Send this event - subject to sampling.
void	sendPresampled()	Send this event - bypassing sampling.
Event	setSampleRate(int sampleRate)
String	toString()

Methods inherited from class io.honeycomb.libhoney.eventdata.EventData

addField, addFields, addMetadata, addMetadata, getApiHost, getDataset, getFields, getMetadata, getSampleRate, getTimestamp, getWriteKey, setApiHost, setDataset, setTimestamp, setWriteKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getSelf

protected Event getSelf()

Specified by:

getSelf in class EventData<Event>

send

public void send()

Send this event - subject to sampling. Note that it is possible to call this multiple times on the same instance, so be aware of how this might be interpreted by honeycomb.

Throws:

IllegalArgumentException - if client-side validation fails, see HoneyClient's class documentation for the "Event Validation" rules.

sendPresampled

public void sendPresampled()

Send this event - bypassing sampling. Note that it is possible to call this multiple times on the same instance, so be aware of how this might be interpreted by honeycomb.

Throws:

IllegalArgumentException - if client-side validation fails, see HoneyClient's class documentation for the "Event Validation" rules.

setSampleRate

public Event setSampleRate(int sampleRate)

Overrides:

setSampleRate in class EventData<Event>

Parameters:

sampleRate - to set.

Returns:

this.

See Also:

Options.Builder.setSampleRate(int)

toString

public String toString()

Overrides:

toString in class EventData<Event>