com.timgroup.statsd

Class Event.Builder

java.lang.Object

com.timgroup.statsd.Event.Builder

Enclosing class:

Event

public static class Event.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Event	build() Build factory method for the event.
Event.Builder	withAggregationKey(String aggregationKey) Aggregation key for the event.
Event.Builder	withAlertType(Event.AlertType alertType) Alert type for the event.
Event.Builder	withDate(Date date) Date for the event.
Event.Builder	withDate(long millisSinceEpoch) Date for the event.
Event.Builder	withHostname(String hostname) Source hostname for the event.
Event.Builder	withPriority(Event.Priority priority) Priority for the event.
Event.Builder	withSourceTypeName(String sourceTypeName) Source Type name for the event.
Event.Builder	withText(String text) Text for the event.
Event.Builder	withTitle(String title) Title for the event.

Methods inherited from class java.lang.Object

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

Method Detail

build

public Event build()

Build factory method for the event.

Returns:

Event built following specified options.

withTitle

public Event.Builder withTitle(String title)

Title for the event.

Parameters:

title - Event title ; mandatory

Returns:

Builder object being used.

withText

public Event.Builder withText(String text)

Text for the event.

Parameters:

text - Event text ; supports line breaks ; mandatory

Returns:

Builder object being used.

withDate

public Event.Builder withDate(Date date)

Date for the event.

Parameters:

date - Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)

Returns:

Builder object being used.

withDate

public Event.Builder withDate(long millisSinceEpoch)

Date for the event.

Parameters:

millisSinceEpoch - Assign a timestamp to the event ; Default: none (Default is the current Unix epoch timestamp when not sent)

Returns:

Builder object being used.

withHostname

public Event.Builder withHostname(String hostname)

Source hostname for the event.

Parameters:

hostname - Assign a hostname to the event ; Default: none

Returns:

Builder object being used.

withAggregationKey

public Event.Builder withAggregationKey(String aggregationKey)

Aggregation key for the event.

Parameters:

aggregationKey - Assign an aggregation key to the event, to group it with some others ; Default: none

Returns:

Builder object being used.

withPriority

public Event.Builder withPriority(Event.Priority priority)

Priority for the event.

Parameters:

priority - Can be "normal" or "low" ; Default: "normal"

Returns:

Builder object being used.

withSourceTypeName

public Event.Builder withSourceTypeName(String sourceTypeName)

Source Type name for the event.

Parameters:

sourceTypeName - Assign a source type to the event ; Default: none

Returns:

Builder object being used.

withAlertType

public Event.Builder withAlertType(Event.AlertType alertType)

Alert type for the event.

Parameters:

alertType - Can be "error", "warning", "info" or "success" ; Default: "info"

Returns:

Builder object being used.