io.honeycomb

Class Event

java.lang.Object

io.honeycomb.Event

public class Event
extends Object

Stores a Builder and some metadata, executes all dynamic fields upon instantiation, and can enqueue HTTP requests to Transmission.

Constructor Summary

Constructors

Constructor and Description
Event(LibHoney libhoney, Builder builder) Constructs a new Event with a default metadata string inherited from LibHoney.
Event(LibHoney libhoney, Builder builder, String metadata) Constructs a new Event from a Builder, executing all dynamic fields and storing them as fields.

Method Summary

Modifier and Type	Method and Description
void	add(Map<String,Object> fields) Copies all of the field mappings from the specified map to this Builder.
void	addField(String key, Object value) Associates the specified value with the specified key in the fields map.
String	getCreatedAt() Returns the time when this Event was created.
String	getDataSet() Returns the data set identifier for this Event.
Map<String,Object>	getFields() Returns fields for this Event.
String	getMetadata() Returns the metadata string for this Event.
int	getSampleRate() Returns the sample rate for this Event.
String	getWriteKey() Returns the write key for this Event.
void	send() Enqueues this Event with Transmission as a request, or as a dropped response if it should be dropped.
void	setDataSet(String dataSet) Sets the data set
void	setMetadata(String metadata) Sets the metadata string
void	setSampleRate(int sampleRate) Sets the sample rate
void	setWriteKey(String writeKey) Sets the write key
boolean	shouldSendEvent() Returns true if this Event should be dropped (due to the sample rate).
org.json.JSONObject	toJson() Returns a JSON representation of this Event.
String	toString() Returns a string representation of this Event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(LibHoney libhoney,
             Builder builder)

Constructs a new Event with a default metadata string inherited from LibHoney.

Parameters:

libhoney - LibHoney

builder - builder from which this Event is built

Event

public Event(LibHoney libhoney,
             Builder builder,
             String metadata)

Constructs a new Event from a Builder, executing all dynamic fields and storing them as fields.

Parameters:

libhoney - LibHoney

builder - builder from which this Event is built

metadata - metadata for debugging purposes

Method Detail

add

public void add(Map<String,Object> fields)

Copies all of the field mappings from the specified map to this Builder.

Parameters:

fields - field mappings to be added to this Builder

addField

public void addField(String key,
                     Object value)

Associates the specified value with the specified key in the fields map.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

getCreatedAt

public String getCreatedAt()

Returns the time when this Event was created.

Returns:

the time when this Event was created

getDataSet

public String getDataSet()

Returns the data set identifier for this Event.

Returns:

the data set identifier for this Event

getFields

public Map<String,Object> getFields()

Returns fields for this Event.

Returns:

fields for this Event

getMetadata

public String getMetadata()

Returns the metadata string for this Event.

Returns:

the metadata string for this Event

getSampleRate

public int getSampleRate()

Returns the sample rate for this Event.

Returns:

the sample rate for this Event

getWriteKey

public String getWriteKey()

Returns the write key for this Event.

Returns:

the write key for this Event.

send

public void send()
          throws HoneyException

Enqueues this Event with Transmission as a request, or as a dropped response if it should be dropped.

Throws:

HoneyException - if there is something wrong with the request

setDataSet

public void setDataSet(String dataSet)

Sets the data set

Parameters:

dataSet - data set

setMetadata

public void setMetadata(String metadata)

Sets the metadata string

Parameters:

metadata - metadata string

setSampleRate

public void setSampleRate(int sampleRate)

Sets the sample rate

Parameters:

sampleRate - sample rate

setWriteKey

public void setWriteKey(String writeKey)

Sets the write key

Parameters:

writeKey - write key

shouldSendEvent

public boolean shouldSendEvent()

Returns true if this Event should be dropped (due to the sample rate).

Returns:

true if this Event should be dropped

toJson

public org.json.JSONObject toJson()

Returns a JSON representation of this Event.

Returns:

a JSON representation of this Event

toString

public String toString()

Returns a string representation of this Event.

Overrides:

toString in class Object

Returns:

a string representation of this Event