org.hawkular.alerts.api.model.data

Class Data

java.lang.Object

org.hawkular.alerts.api.model.data.Data

All Implemented Interfaces:

Serializable, Comparable<Data>

public class Data
extends Object
implements Comparable<Data>, Serializable

A base class for incoming data into alerts subsystem. All Data has TenantId, Id and a timestamp. An Id should be unique within the tenant. The timestamp is used to ensure that data is time-ordered when being sent into the alerting engine. If not assigned the timestamp will be assigned to current time.

Author:

Jay Shaughnessy, Lucas Ponce

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	context Optional, non-evaluated contextual data to be kept with the datum
protected String	id
protected String	source
static String	SOURCE_NONE
protected String	tenantId
protected long	timestamp
protected String	value For single-value condition types.

Constructor Summary

Constructors

Constructor and Description
Data() For JSON Construction ONLY
Data(String id, long timestamp, String value) For REST API USE ONLY, tenantId set automatically via REST Handler.
Data(String source, String id, long timestamp, String value) For REST API USE ONLY, tenantId set automatically via REST Handler.
Data(String tenantId, String source, String id, long timestamp, Map<String,String> values) Construct a multi-value datum with no context data.
Data(String tenantId, String source, String id, long timestamp, Map<String,String> values, Map<String,String> context) Construct a multi-value datum with context data.
Data(String tenantId, String source, String id, long timestamp, String value) Construct a single-value datum with no context data.
Data(String tenantId, String source, String id, long timestamp, String value, Map<String,String> context) Construct a single-value datum with context data.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String name, String value)
int	compareTo(Data o)
boolean	equals(Object obj)
static Data	forAvailability(String tenantId, String id, long timestamp, AvailabilityType value)
static Data	forAvailability(String tenantId, String id, long timestamp, AvailabilityType value, Map<String,String> context)
static Data	forAvailability(String tenantId, String source, String id, long timestamp, AvailabilityType value)
static Data	forAvailability(String tenantId, String source, String id, long timestamp, AvailabilityType value, Map<String,String> context)
static Data	forNumeric(String tenantId, String id, long timestamp, Double value)
static Data	forNumeric(String tenantId, String id, long timestamp, Double value, Map<String,String> context)
static Data	forNumeric(String tenantId, String source, String id, long timestamp, Double value)
static Data	forNumeric(String tenantId, String source, String id, long timestamp, Double value, Map<String,String> context)
static Data	forString(String tenantId, String id, long timestamp, String value)
static Data	forString(String tenantId, String id, long timestamp, String value, Map<String,String> context)
static Data	forString(String tenantId, String source, String id, long timestamp, String value)
static Data	forString(String tenantId, String source, String id, long timestamp, String value, Map<String,String> context)
Map<String,String>	getContext()
String	getId()
String	getSource()
String	getTenantId()
long	getTimestamp()
String	getValue()
int	hashCode()
void	setContext(Map<String,String> context)
void	setId(String id)
void	setSource(String source)
void	setTenantId(String tenantId)
void	setTimestamp(long timestamp)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_NONE

public static final String SOURCE_NONE

See Also:

Constant Field Values

tenantId

protected String tenantId

source

protected String source

id

protected String id

timestamp

protected long timestamp

value

protected String value

For single-value condition types. Null otherwise

context

protected Map<String,String> context

Optional, non-evaluated contextual data to be kept with the datum

Constructor Detail

Data

public Data()

For JSON Construction ONLY

Data

public Data(String id,
            long timestamp,
            String value)

For REST API USE ONLY, tenantId set automatically via REST Handler.

Data

public Data(String source,
            String id,
            long timestamp,
            String value)

For REST API USE ONLY, tenantId set automatically via REST Handler.

Data

public Data(String tenantId,
            String source,
            String id,
            long timestamp,
            String value)

Construct a single-value datum with no context data.

Parameters:

tenantId - not null

id - not null, unique within tenant

timestamp - in millis, if less than 1 assigned currentTime.

value - the value

Data

public Data(String tenantId,
            String source,
            String id,
            long timestamp,
            String value,
            Map<String,String> context)

Construct a single-value datum with context data.

Parameters:

tenantId - not null

id - not null, unique within tenant

timestamp - in millis, if less than 1 assigned currentTime.

value - the value

context - optional, contextual name-value pairs to be stored with the data.

Data

public Data(String tenantId,
            String source,
            String id,
            long timestamp,
            Map<String,String> values)

Construct a multi-value datum with no context data.

Parameters:

tenantId - not null

id - not null, unique within tenant

timestamp - in millis, if less than 1 assigned currentTime.

values - the values

Data

public Data(String tenantId,
            String source,
            String id,
            long timestamp,
            Map<String,String> values,
            Map<String,String> context)

Construct a multi-value datum with context data.

Parameters:

tenantId - not null

id - not null

timestamp - in millis, if less than 1 assigned currentTime.

values - the values

context - optional, contextual name-value pairs to be stored with the data.

Method Detail

forNumeric

public static Data forNumeric(String tenantId,
                              String id,
                              long timestamp,
                              Double value)

forNumeric

public static Data forNumeric(String tenantId,
                              String source,
                              String id,
                              long timestamp,
                              Double value)

forNumeric

public static Data forNumeric(String tenantId,
                              String id,
                              long timestamp,
                              Double value,
                              Map<String,String> context)

forNumeric

public static Data forNumeric(String tenantId,
                              String source,
                              String id,
                              long timestamp,
                              Double value,
                              Map<String,String> context)

forString

public static Data forString(String tenantId,
                             String id,
                             long timestamp,
                             String value)

forString

public static Data forString(String tenantId,
                             String source,
                             String id,
                             long timestamp,
                             String value)

forString

public static Data forString(String tenantId,
                             String id,
                             long timestamp,
                             String value,
                             Map<String,String> context)

forString

public static Data forString(String tenantId,
                             String source,
                             String id,
                             long timestamp,
                             String value,
                             Map<String,String> context)

forAvailability

public static Data forAvailability(String tenantId,
                                   String id,
                                   long timestamp,
                                   AvailabilityType value)

forAvailability

public static Data forAvailability(String tenantId,
                                   String source,
                                   String id,
                                   long timestamp,
                                   AvailabilityType value)

forAvailability

public static Data forAvailability(String tenantId,
                                   String id,
                                   long timestamp,
                                   AvailabilityType value,
                                   Map<String,String> context)

forAvailability

public static Data forAvailability(String tenantId,
                                   String source,
                                   String id,
                                   long timestamp,
                                   AvailabilityType value,
                                   Map<String,String> context)

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)

getSource

public String getSource()

setSource

public void setSource(String source)

getId

public String getId()

setId

public void setId(String id)

getTimestamp

public long getTimestamp()

setTimestamp

public void setTimestamp(long timestamp)

Parameters:

timestamp - in millis, if less than 1 assigned currentTime.

getValue

public String getValue()

setValue

public void setValue(String value)

getContext

public Map<String,String> getContext()

setContext

public void setContext(Map<String,String> context)

addProperty

public void addProperty(String name,
                        String value)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Data o)

Specified by:

compareTo in interface Comparable<Data>

toString

public String toString()

Overrides:

toString in class Object