Package com.suse.salt.netapi.calls

Class RunnerCall<R>

java.lang.Object

com.suse.salt.netapi.calls.AbstractCall<R>

com.suse.salt.netapi.calls.RunnerCall<R>

Type Parameters:

R - the return type of the called function

All Implemented Interfaces:

Call<R>

public class RunnerCall<R>
extends AbstractCall<R>

Class representing a function call of a salt runner module.

Constructor Summary

Constructors

Constructor	Description
RunnerCall(String functionName, Optional<Map<String,?>> kwargs, com.google.gson.reflect.TypeToken<R> returnType)

Method Summary

Modifier and Type	Method	Description
CompletionStage<RunnerAsyncResult<R>>	callAsync(SaltClient client, AuthMethod auth)	Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
CompletionStage<Result<R>>	callSync(SaltClient client, AuthMethod auth)	Calls a runner module function on the master and synchronously waits for the result.
Map<String,Object>	getPayload()	Return the call payload as a map of key/value pairs.

Methods inherited from class com.suse.salt.netapi.calls.AbstractCall

getFunctionName, getModuleName, getReturnType

Methods inherited from class java.lang.Object

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

Constructor Detail

RunnerCall

public RunnerCall(String functionName,
                  Optional<Map<String,?>> kwargs,
                  com.google.gson.reflect.TypeToken<R> returnType)

Method Detail

getPayload

public Map<String,Object> getPayload()

Return the call payload as a map of key/value pairs. Usually this contains the function name and arguments, but the various clients differ in the details.

Returns:

call payload as a map of key/value pairs

callAsync

public CompletionStage<RunnerAsyncResult<R>> callAsync(SaltClient client,
                                                       AuthMethod auth)

Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result. Authentication is done with the token therefore you have to login prior to using this function.

Parameters:

client - SaltClient instance

auth - authentication credentials to use

Returns:

information about the scheduled job

callSync

public CompletionStage<Result<R>> callSync(SaltClient client,
                                           AuthMethod auth)

Calls a runner module function on the master and synchronously waits for the result. Authentication is done with the given credentials no session token is created.

Parameters:

client - SaltClient instance

auth - authentication credentials to use

Returns:

the result of the called function