com.suse.salt.netapi.results

Class ResultInfo

java.lang.Object

com.suse.salt.netapi.results.ResultInfo

public class ResultInfo
extends Object

Represents the Salt API's result information structure.

Constructor Summary

Constructors

Constructor and Description
ResultInfo()

Method Summary

Modifier and Type	Method and Description
List<Object>	getArguments() Returns a list of arguments supplied function.
String	getFunction() Returns function name.
Set<String>	getMinions() Returns set of minions this job was submitted to.
Set<String>	getPendingMinions() Returns a set of minions that have yet to return a result.
Optional<Object>	getResult(String minion) Returns job's return value that is associated with supplied minion as an Optional.
Map<String,Object>	getResults() Returns result map of available Object associated with each minion.
Date	getStartTime() Returns start time assuming default TimeZone is Salt master's timezone.
Date	getStartTime(TimeZone tz) Returns start time of the job.
String	getTarget() Returns target of job submission.
String	getUser() Returns user associated with this job.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultInfo

public ResultInfo()

Method Detail

getArguments

public List<Object> getArguments()

Returns a list of arguments supplied function.

Returns:

list of Objects

getFunction

public String getFunction()

Returns function name.

Returns:

function name

getMinions

public Set<String> getMinions()

Returns set of minions this job was submitted to.

Returns:

minion set

getStartTime

public Date getStartTime(TimeZone tz)

Returns start time of the job.

Parameters:

tz - - TimeZone associated with the master of this job.

Returns:

job start date

getStartTime

public Date getStartTime()

Returns start time assuming default TimeZone is Salt master's timezone.

Returns:

Date representation of the start time.

getTarget

public String getTarget()

Returns target of job submission.

Returns:

job submission target

getUser

public String getUser()

Returns user associated with this job.

Returns:

job's user

getResult

public Optional<Object> getResult(String minion)

Returns job's return value that is associated with supplied minion as an Optional. If a minion has not returned a response, an empty value is returned.

Parameters:

minion - - name of a minion

Returns:

Optional associated with the result from a given minion.

getResults

public Map<String,Object> getResults()

Returns result map of available Object associated with each minion. Minions that have yet to return a value are not included in this mapping.

Returns:

Map<String, Object> of available job return values.

getPendingMinions

public Set<String> getPendingMinions()

Returns a set of minions that have yet to return a result.

Returns:

set of minions that have not returned a result.