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 and Description
RunnerCall(String functionName, Optional<Map<String,?>> kwargs, com.google.gson.reflect.TypeToken<R> returnType)
RunnerCall(String moduleName, String functionName, Optional<Map<String,?>> kwargs, com.google.gson.reflect.TypeToken<R> returnType)

Method Summary

Modifier and Type	Method and Description
RunnerAsyncResult<R>	callAsync(SaltClient client) Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
RunnerAsyncResult<R>	callAsync(SaltClient client, String username, String password, AuthModule authModule) Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
R	callSync(SaltClient client) Calls a runner module function on the master and synchronously waits for the result.
R	callSync(SaltClient client, String username, String password, AuthModule authModule) Calls a runner module function on the master and synchronously waits for the result.

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

getModuleName, getPayload, 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)

RunnerCall

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

Method Detail

callAsync

public RunnerAsyncResult<R> callAsync(SaltClient client)
                               throws SaltException

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

Returns:

information about the scheduled job

Throws:

SaltException - if anything goes wrong

callAsync

public RunnerAsyncResult<R> callAsync(SaltClient client,
                                      String username,
                                      String password,
                                      AuthModule authModule)
                               throws SaltException

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 given credentials no session token is created.

Parameters:

client - SaltClient instance

username - username for authentication

password - password for authentication

authModule - authentication module to use

Returns:

information about the scheduled job

Throws:

SaltException - if anything goes wrong

callSync

public R callSync(SaltClient client,
                  String username,
                  String password,
                  AuthModule authModule)
           throws SaltException

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

username - username for authentication

password - password for authentication

authModule - authentication module to use

Returns:

the result of the called function

Throws:

SaltException - if anything goes wrong

callSync

public R callSync(SaltClient client)
           throws SaltException

Calls a runner module function on the master and synchronously waits for the result. Authentication is done with the token therefore you have to login prior to using this function.

Parameters:

client - SaltClient instance

Returns:

the result of the called function

Throws:

SaltException - if anything goes wrong