com.suse.salt.netapi.event

Class EngineEvent

java.lang.Object

com.suse.salt.netapi.event.EngineEvent

public class EngineEvent
extends Object

Represents an event fired by engines

Method Summary

Modifier and Type	Method and Description
String	getAdditional() Provides additional information from the tag depending on the type of engine
Map<String,Object>	getData() Return event data as Map
<R> R	getData(Class<R> type) Return this event's data parsed into the given type.
<R> R	getData(com.google.gson.reflect.TypeToken<R> type) Return the event data parsed into the given type.
String	getEngine() Returns the engine name.
Optional<String>	getMinionId() Returns the id of the minion that triggered the engine event
String	getTimestamp() Returns the timestamp of the event
static Optional<EngineEvent>	parse(Event event) Utility method to parse e generic event to a more specific one

Methods inherited from class java.lang.Object

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

Method Detail

getEngine

public String getEngine()

Returns the engine name.

Returns:

the engine name

getAdditional

public String getAdditional()

Provides additional information from the tag depending on the type of engine

Returns:

additional information

getTimestamp

public String getTimestamp()

Returns the timestamp of the event

Returns:

the timestamp

getMinionId

public Optional<String> getMinionId()

Returns the id of the minion that triggered the engine event

Returns:

the minion id

getData

public <R> R getData(com.google.gson.reflect.TypeToken<R> type)

Return the event data parsed into the given type.

Type Parameters:

R - type to parse the data into

Parameters:

type - type token to parse data

Returns:

the event data

getData

public <R> R getData(Class<R> type)

Return this event's data parsed into the given type.

Type Parameters:

R - type to parse the data into

Parameters:

type - class to parse data

Returns:

the data

getData

public Map<String,Object> getData()

Return event data as Map

Returns:

event data as map

parse

public static Optional<EngineEvent> parse(Event event)

Utility method to parse e generic event to a more specific one

Parameters:

event - the generic event to parse

Returns:

an option containing the parsed value or non if it could not be parsed