com.suse.salt.netapi.event

Class BeaconEvent

java.lang.Object

com.suse.salt.netapi.event.BeaconEvent

public class BeaconEvent
extends Object

Represents an event fired by beacons

Constructor Summary

Constructors

Constructor and Description
BeaconEvent(String minionId, String beacon, String additional, Map<String,Object> data) Creates a new BeaconEvent

Method Summary

Modifier and Type	Method and Description
String	getAdditional() Provides additional information from the tag depending on the type of beacon
String	getBeacon() Returns the beacon name.
Map<String,Object>	getData() The event data containing more information about this event
String	getMinionId() Returns the id of the minion that triggered the beacon
static Optional<BeaconEvent>	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

BeaconEvent

public BeaconEvent(String minionId,
                   String beacon,
                   String additional,
                   Map<String,Object> data)

Creates a new BeaconEvent

Parameters:

minionId - the id of the minion sending the event

beacon - the beacon name

additional - additional information depending on the beacon

data - data containing more information about this event

Method Detail

getBeacon

public String getBeacon()

Returns the beacon name.

Returns:

the beacon name

getMinionId

public String getMinionId()

Returns the id of the minion that triggered the beacon

Returns:

the minion id

getAdditional

public String getAdditional()

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

Returns:

additional information

getData

public Map<String,Object> getData()

The event data containing more information about this event

Returns:

the event data

parse

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