Package com.suse.salt.netapi.event
Class ResultEvent
- java.lang.Object
-
- com.suse.salt.netapi.event.ResultEvent
-
public class ResultEvent extends java.lang.Object
Represents an event containing the result of some function call
-
-
Constructor Summary
Constructors Constructor Description ResultEvent(java.lang.String jid, java.lang.String minionId, com.google.gson.JsonElement data)
Creates a new ResultEvent
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.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(java.lang.Class<R> type)
Return this event's data parsed into the given type.java.lang.String
getJid()
The job id to which the result belongsjava.lang.String
getMinionId()
The id of the minion from which the result camestatic java.util.Optional<ResultEvent>
parse(Event event)
Utility method to parse e generic event to a more specific one
-
-
-
Constructor Detail
-
ResultEvent
public ResultEvent(java.lang.String jid, java.lang.String minionId, com.google.gson.JsonElement data)
Creates a new ResultEvent- Parameters:
jid
- the id of the job this event is aboutminionId
- the id of the minion sending the eventdata
- data containing more information about this event
-
-
Method Detail
-
getJid
public java.lang.String getJid()
The job id to which the result belongs- Returns:
- the job id
-
getMinionId
public java.lang.String getMinionId()
The id of the minion from which the result came- Returns:
- the minion id
-
getData
public java.util.Map<java.lang.String,java.lang.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(java.lang.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 java.util.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
-
-