R
- the return type of the called functionpublic class LocalCall<R> extends AbstractCall<R>
Modifier and Type | Field and Description |
---|---|
private java.util.Optional<java.util.List<?>> |
arg |
private java.util.Optional<java.lang.Integer> |
gatherJobTimeout |
private java.util.Optional<java.util.Map<java.lang.String,?>> |
kwarg |
private java.util.Optional<?> |
metadata |
private java.util.Optional<java.lang.Integer> |
timeout |
Constructor and Description |
---|
LocalCall(java.lang.String functionName,
java.util.Optional<java.util.List<?>> arg,
java.util.Optional<java.util.Map<java.lang.String,?>> kwarg,
com.google.gson.reflect.TypeToken<R> returnType) |
LocalCall(java.lang.String functionName,
java.util.Optional<java.util.List<?>> arg,
java.util.Optional<java.util.Map<java.lang.String,?>> kwarg,
com.google.gson.reflect.TypeToken<R> returnType,
java.util.Optional<?> metadata) |
LocalCall(java.lang.String functionName,
java.util.Optional<java.util.List<?>> arg,
java.util.Optional<java.util.Map<java.lang.String,?>> kwarg,
com.google.gson.reflect.TypeToken<R> returnType,
java.util.Optional<?> metadata,
java.util.Optional<java.lang.Integer> timeout,
java.util.Optional<java.lang.Integer> gatherJobTimeout) |
LocalCall(java.lang.String functionName,
java.util.Optional<java.util.List<?>> arg,
java.util.Optional<java.util.Map<java.lang.String,?>> kwarg,
com.google.gson.reflect.TypeToken<R> returnType,
java.util.Optional<java.lang.Integer> timeout,
java.util.Optional<java.lang.Integer> gatherJobTimeout) |
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> |
callAsync(java.util.function.Function<LocalCall<R>,java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>>> localAsync,
java.util.function.Function<RunnerCall<java.util.Map<java.lang.String,R>>,java.util.concurrent.CompletionStage<RunnerAsyncResult<java.util.Map<java.lang.String,R>>>> runnerAsync,
EventStream events,
java.util.concurrent.CompletionStage<GenericError> cancel)
Calls this salt call via the async client and returns the results
as they come in via the event stream.
|
java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> |
callAsync(SaltClient client,
Target<?> target,
AuthMethod auth)
Calls a execution module function on the given target asynchronously and
returns information about the scheduled job that can be used to query the result.
|
java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> |
callAsync(SaltClient client,
Target<?> target,
AuthMethod auth,
Batch batch)
Calls a execution module function on the given target asynchronously and
returns information about the scheduled job that can be used to query the result.
|
java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> |
callAsync(SaltClient client,
Target<?> target,
AuthMethod auth,
EventStream events,
java.util.concurrent.CompletionStage<GenericError> cancel,
Batch batch)
Calls this salt call via the async client and returns the results
as they come in via the event stream.
|
java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> |
callAsync(SaltClient client,
Target<?> target,
AuthMethod auth,
EventStream events,
java.util.concurrent.CompletionStage<GenericError> cancel,
java.util.Optional<Batch> batch)
Calls this salt call via the async client and returns the results
as they come in via the event stream.
|
java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> |
callAsync(SaltClient client,
Target<?> target,
AuthMethod auth,
java.util.Optional<Batch> batch)
Calls a execution module function on the given target asynchronously and
returns information about the scheduled job that can be used to query the result.
|
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,Result<R>>> |
callSync(SaltClient client,
Target<?> target,
AuthMethod auth)
Calls a execution module function on the given target and synchronously
waits for the result.
|
java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> |
callSync(SaltClient client,
Target<?> target,
AuthMethod auth,
Batch batch)
Calls a execution module function on the given target with batching and
synchronously waits for the result.
|
java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> |
callSync(SaltClient client,
Target<?> target,
AuthMethod auth,
java.util.Optional<Batch> batch)
Calls a execution module function on the given target with batching and
synchronously waits for the result.
|
private java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> |
callSyncHelperNonBlock(SaltClient client,
Target<?> target,
AuthMethod auth,
java.util.Optional<Batch> batch)
Helper to call an execution module function on the given target for batched or
unbatched while also providing an option to use the given credentials or to use a
prior created token.
|
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,Result<SSHResult<R>>>> |
callSyncSSH(SaltClient client,
SSHTarget<?> target,
SaltSSHConfig cfg,
AuthMethod auth)
Call an execution module function on the given target via salt-ssh and synchronously
wait for the result.
|
java.util.Map<java.lang.String,java.lang.Object> |
getPayload()
Return the call payload as a map of key/value pairs.
|
private java.util.List<java.util.Map<java.lang.String,Result<R>>> |
handleRetcodeBatchingHack(java.util.List<java.util.Map<java.lang.String,Result<R>>> list,
java.lang.reflect.Type xor) |
private static <R> void |
onJobReturn(java.lang.String jid,
JobReturnEvent jre,
com.google.gson.reflect.TypeToken<Result<R>> tt,
java.util.Map<java.lang.String,java.util.concurrent.CompletableFuture<Result<R>>> targets) |
private static <R> void |
onRunnerReturn(java.lang.String jid,
RunnerReturnEvent rre,
com.google.gson.reflect.TypeToken<Result<R>> tt,
java.util.Map<java.lang.String,java.util.concurrent.CompletableFuture<Result<R>>> targets) |
LocalCall<R> |
withMetadata(java.lang.Object metadata) |
LocalCall<R> |
withoutMetadata() |
LocalCall<R> |
withoutTimeouts() |
LocalCall<R> |
withTimeouts(java.util.Optional<java.lang.Integer> timeout,
java.util.Optional<java.lang.Integer> gatherJobTimeout) |
getFunction, getFunctionName, getModuleName, getReturnType
private final java.util.Optional<java.util.List<?>> arg
private final java.util.Optional<java.util.Map<java.lang.String,?>> kwarg
private final java.util.Optional<?> metadata
private final java.util.Optional<java.lang.Integer> timeout
private final java.util.Optional<java.lang.Integer> gatherJobTimeout
public LocalCall(java.lang.String functionName, java.util.Optional<java.util.List<?>> arg, java.util.Optional<java.util.Map<java.lang.String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, java.util.Optional<?> metadata, java.util.Optional<java.lang.Integer> timeout, java.util.Optional<java.lang.Integer> gatherJobTimeout)
public LocalCall(java.lang.String functionName, java.util.Optional<java.util.List<?>> arg, java.util.Optional<java.util.Map<java.lang.String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, java.util.Optional<java.lang.Integer> timeout, java.util.Optional<java.lang.Integer> gatherJobTimeout)
public LocalCall(java.lang.String functionName, java.util.Optional<java.util.List<?>> arg, java.util.Optional<java.util.Map<java.lang.String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType, java.util.Optional<?> metadata)
public LocalCall(java.lang.String functionName, java.util.Optional<java.util.List<?>> arg, java.util.Optional<java.util.Map<java.lang.String,?>> kwarg, com.google.gson.reflect.TypeToken<R> returnType)
public LocalCall<R> withTimeouts(java.util.Optional<java.lang.Integer> timeout, java.util.Optional<java.lang.Integer> gatherJobTimeout)
public java.util.Map<java.lang.String,java.lang.Object> getPayload()
public java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> callAsync(SaltClient client, Target<?> target, AuthMethod auth, Batch batch)
client
- SaltClient instancetarget
- the target for the functionauth
- authentication credentials to usebatch
- parameter for enabling and configuring batchingpublic java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> callAsync(SaltClient client, Target<?> target, AuthMethod auth, java.util.Optional<Batch> batch)
client
- SaltClient instancetarget
- the target for the functionauth
- authentication credentials to usebatch
- parameter for enabling and configuring batchingpublic java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>> callAsync(SaltClient client, Target<?> target, AuthMethod auth)
client
- SaltClient instancetarget
- the target for the functionauth
- authentication credentials to usepublic java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> callAsync(SaltClient client, Target<?> target, AuthMethod auth, EventStream events, java.util.concurrent.CompletionStage<GenericError> cancel, Batch batch)
client
- SaltClient instancetarget
- the target for the functionevents
- the event stream to usecancel
- future to cancel the actionauth
- authentication credentials to usebatch
- parameter for enabling and configuring batchingpublic java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> callAsync(SaltClient client, Target<?> target, AuthMethod auth, EventStream events, java.util.concurrent.CompletionStage<GenericError> cancel, java.util.Optional<Batch> batch)
client
- SaltClient instancetarget
- the target for the functionevents
- the event stream to usecancel
- future to cancel the actionauth
- authentication credentials to usebatch
- parameter for enabling and configuring batchingpublic java.util.concurrent.CompletionStage<java.util.Optional<java.util.Map<java.lang.String,java.util.concurrent.CompletionStage<Result<R>>>>> callAsync(java.util.function.Function<LocalCall<R>,java.util.concurrent.CompletionStage<java.util.Optional<LocalAsyncResult<R>>>> localAsync, java.util.function.Function<RunnerCall<java.util.Map<java.lang.String,R>>,java.util.concurrent.CompletionStage<RunnerAsyncResult<java.util.Map<java.lang.String,R>>>> runnerAsync, EventStream events, java.util.concurrent.CompletionStage<GenericError> cancel)
localAsync
- function providing callAsync for LocalCallsrunnerAsync
- function providing callAsync for RunnerCallsevents
- the event stream to usecancel
- future to cancel the actionpublic java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,Result<R>>> callSync(SaltClient client, Target<?> target, AuthMethod auth)
client
- SaltClient instancetarget
- the target for the functionauth
- authentication credentials to usepublic java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> callSync(SaltClient client, Target<?> target, AuthMethod auth, Batch batch)
client
- SaltClient instancetarget
- the target for the functionbatch
- the batch specificationauth
- authentication credentials to usepublic java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> callSync(SaltClient client, Target<?> target, AuthMethod auth, java.util.Optional<Batch> batch)
client
- SaltClient instancetarget
- the target for the functionauth
- authentication credentials to usebatch
- parameter for enabling and configuring batchingprivate java.util.List<java.util.Map<java.lang.String,Result<R>>> handleRetcodeBatchingHack(java.util.List<java.util.Map<java.lang.String,Result<R>>> list, java.lang.reflect.Type xor)
private java.util.concurrent.CompletionStage<java.util.List<java.util.Map<java.lang.String,Result<R>>>> callSyncHelperNonBlock(SaltClient client, Target<?> target, AuthMethod auth, java.util.Optional<Batch> batch)
client
- SaltClient instancetarget
- the target for the functionbatch
- the batch parameter, empty for unbatchedauth
- authentication credentials to usepublic java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,Result<SSHResult<R>>>> callSyncSSH(SaltClient client, SSHTarget<?> target, SaltSSHConfig cfg, AuthMethod auth)
client
- SaltClient instancetarget
- the target for the functioncfg
- Salt SSH configuration objectauth
- authentication credentials to useprivate static <R> void onRunnerReturn(java.lang.String jid, RunnerReturnEvent rre, com.google.gson.reflect.TypeToken<Result<R>> tt, java.util.Map<java.lang.String,java.util.concurrent.CompletableFuture<Result<R>>> targets)
private static <R> void onJobReturn(java.lang.String jid, JobReturnEvent jre, com.google.gson.reflect.TypeToken<Result<R>> tt, java.util.Map<java.lang.String,java.util.concurrent.CompletableFuture<Result<R>>> targets)