com.heroiclabs.satori

Class Event

java.lang.Object

com.heroiclabs.satori.Event

public class Event
extends java.lang.Object

An event to be published to the server.

Constructor Summary

Constructors

Constructor and Description
Event(@NotNull java.lang.String name, @NotNull java.time.Instant timestamp, @NotNull java.lang.String value, java.util.Map<java.lang.String,java.lang.String> metadata) The event constructor.
Event(@NotNull java.lang.String name, @NotNull java.time.Instant timestamp, @NotNull java.lang.String value, java.util.Map<java.lang.String,java.lang.String> metadata, java.lang.String id) The event constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getId() Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Event metadata, if any.
java.lang.String	getName() The name of the event.
java.time.Instant	getTimestamp() The time when the event was triggered.
java.lang.String	getValue() Optional value.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(@NotNull
             @NotNull java.lang.String name,
             @NotNull
             @NotNull java.time.Instant timestamp,
             @NotNull
             @NotNull java.lang.String value,
             java.util.Map<java.lang.String,java.lang.String> metadata,
             java.lang.String id)

The event constructor.

Parameters:

name - The name of the event.

timestamp - The time when the event was triggered.

value - Optional value.

metadata - Event metadata, if any.

id - Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios. If not supplied the server will assign a randomly generated unique event identifier.

Event

public Event(@NotNull
             @NotNull java.lang.String name,
             @NotNull
             @NotNull java.time.Instant timestamp,
             @NotNull
             @NotNull java.lang.String value,
             java.util.Map<java.lang.String,java.lang.String> metadata)

The event constructor.

Parameters:

name - The name of the event.

timestamp - The time when the event was triggered.

value - Optional value.

metadata - Event metadata, if any.

Method Detail

getName

public java.lang.String getName()

The name of the event.

Returns:

name

getTimestamp

public java.time.Instant getTimestamp()

The time when the event was triggered.

Returns:

timestamp

getValue

public java.lang.String getValue()

Optional value.

Returns:

value

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Event metadata, if any.

Returns:

metadata

getId

public java.lang.String getId()

Optional event ID assigned by the client, used to de-duplicate in retransmission scenarios.

Returns:

id

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object