Package com.suse.salt.netapi.event

Class ResultEvent

java.lang.Object

com.suse.salt.netapi.event.ResultEvent

public class ResultEvent
extends Object

Represents an event containing the result of some function call

Constructor Summary

Constructors

Constructor	Description
ResultEvent(String jid, String minionId, com.google.gson.JsonElement data)	Creates a new ResultEvent

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getData()	Return event data as Map
<R> R	getData(com.google.gson.reflect.TypeToken<R> type)	Return the event data parsed into the given type.
<R> R	getData(Class<R> type)	Return this event's data parsed into the given type.
String	getJid()	The job id to which the result belongs
String	getMinionId()	The id of the minion from which the result came
static Optional<ResultEvent>	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

Constructor Detail

ResultEvent

public ResultEvent(String jid,
                   String minionId,
                   com.google.gson.JsonElement data)

Creates a new ResultEvent

Parameters:

jid - the id of the job this event is about

minionId - the id of the minion sending the event

data - data containing more information about this event

Method Detail

getJid

public String getJid()

The job id to which the result belongs

Returns:

the job id

getMinionId

public String getMinionId()

The id of the minion from which the result came

Returns:

the minion id

getData

public Map<String,Object> getData()

Return event data as Map

Returns:

event data as map

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

parse

public static Optional<ResultEvent> 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