Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W 

A

accept(String) - Static method in class com.suse.salt.netapi.calls.wheel.Key
 
add(String, Map<String, Object>) - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
add(String, LocalCall<?>, LocalDateTime, Map<String, ?>) - Static method in class com.suse.salt.netapi.calls.modules.Schedule
Schedule a salt call for later execution on the minion
addEventListener(EventListener) - Method in class com.suse.salt.netapi.event.EventStream
ALL - Static variable in class com.suse.salt.netapi.datatypes.target.Glob
 
allstatus() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
Applications - Class in com.suse.salt.netapi.datatypes.cherrypy
Representation of applications statistics.
Applications() - Constructor for class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
apply(List<String>) - Static method in class com.suse.salt.netapi.calls.modules.State
 
apply(String...) - Static method in class com.suse.salt.netapi.calls.modules.State
 
Arguments - Class in com.suse.salt.netapi.datatypes
Representation of args and kwargs.
Arguments() - Constructor for class com.suse.salt.netapi.datatypes.Arguments
 
AuthModule - Enum in com.suse.salt.netapi
Salt authentication modules.

B

Beacon - Class in com.suse.salt.netapi.calls.modules
salt.modules.beacons
Beacon() - Constructor for class com.suse.salt.netapi.calls.modules.Beacon
 
Beacon.Result - Class in com.suse.salt.netapi.calls.modules
Status result of many beacon functions
BeaconEvent - Class in com.suse.salt.netapi.event
Represents an event fired by beacons
BeaconEvent(String, String, String, Map<String, Object>) - Constructor for class com.suse.salt.netapi.event.BeaconEvent
Creates a new BeaconEvent

C

Call<R> - Interface in com.suse.salt.netapi.calls
Interface for all function calls in salt.
call(Call<?>, Client, String, Optional<Map<String, Object>>, TypeToken<R>) - Method in class com.suse.salt.netapi.client.SaltClient
Generic interface to make a Call to an endpoint using a given Client.
call(Call<?>, Client, String, TypeToken<R>) - Method in class com.suse.salt.netapi.client.SaltClient
Convenience method to make a call without arguments.
callAsync(SaltClient, Target<?>) - Method in class com.suse.salt.netapi.calls.LocalCall
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.
callAsync(SaltClient, Target<?>, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.LocalCall
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.
callAsync(SaltClient) - Method in class com.suse.salt.netapi.calls.RunnerCall
Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
callAsync(SaltClient, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.RunnerCall
Calls a runner module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
callAsync(SaltClient) - Method in class com.suse.salt.netapi.calls.WheelCall
Calls a wheel module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
callAsync(SaltClient, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.WheelCall
Calls a wheel module function on the master asynchronously and returns information about the scheduled job that can be used to query the result.
callSync(SaltClient, Target<?>) - Method in class com.suse.salt.netapi.calls.LocalCall
Calls a execution module function on the given target and synchronously waits for the result.
callSync(SaltClient, Target<?>, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.LocalCall
Calls a execution module function on the given target and synchronously waits for the result.
callSync(SaltClient, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.RunnerCall
Calls a runner module function on the master and synchronously waits for the result.
callSync(SaltClient) - Method in class com.suse.salt.netapi.calls.RunnerCall
Calls a runner module function on the master and synchronously waits for the result.
callSync(SaltClient) - Method in class com.suse.salt.netapi.calls.WheelCall
Calls a wheel module function on the master and synchronously waits for the result.
callSync(SaltClient, String, String, AuthModule) - Method in class com.suse.salt.netapi.calls.WheelCall
Calls a wheel module function on the master and synchronously waits for the result.
Client - Enum in com.suse.salt.netapi.calls
Possible values for the client parameter in salt netapi calls.
ClientConfig - Class in com.suse.salt.netapi.config
A statically typed key/value store for the Salt client configuration.
ClientConfig() - Constructor for class com.suse.salt.netapi.config.ClientConfig
 
ClientUtils - Class in com.suse.salt.netapi.utils
Utilities for SaltClient.
ClientUtils() - Constructor for class com.suse.salt.netapi.utils.ClientUtils
 
close() - Method in class com.suse.salt.netapi.event.EventStream
Close the WebSocket Session.
close(CloseReason) - Method in class com.suse.salt.netapi.event.EventStream
Close the WebSocket Session with a given close reason.
closeQuietly(InputStream) - Static method in class com.suse.salt.netapi.utils.ClientUtils
Quietly close a given stream, suppressing exceptions.
Cmd - Class in com.suse.salt.netapi.calls.modules
salt.modules.cmdmod
com.suse.salt.netapi - package com.suse.salt.netapi
 
com.suse.salt.netapi.calls - package com.suse.salt.netapi.calls
 
com.suse.salt.netapi.calls.modules - package com.suse.salt.netapi.calls.modules
 
com.suse.salt.netapi.calls.runner - package com.suse.salt.netapi.calls.runner
 
com.suse.salt.netapi.calls.wheel - package com.suse.salt.netapi.calls.wheel
 
com.suse.salt.netapi.client - package com.suse.salt.netapi.client
 
com.suse.salt.netapi.client.impl - package com.suse.salt.netapi.client.impl
 
com.suse.salt.netapi.config - package com.suse.salt.netapi.config
 
com.suse.salt.netapi.datatypes - package com.suse.salt.netapi.datatypes
 
com.suse.salt.netapi.datatypes.cherrypy - package com.suse.salt.netapi.datatypes.cherrypy
 
com.suse.salt.netapi.datatypes.target - package com.suse.salt.netapi.datatypes.target
 
com.suse.salt.netapi.event - package com.suse.salt.netapi.event
 
com.suse.salt.netapi.exception - package com.suse.salt.netapi.exception
 
com.suse.salt.netapi.parser - package com.suse.salt.netapi.parser
 
com.suse.salt.netapi.results - package com.suse.salt.netapi.results
 
com.suse.salt.netapi.utils - package com.suse.salt.netapi.utils
 
compareTo(SaltVersion) - Method in class com.suse.salt.netapi.datatypes.SaltVersion
 
compound(String, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
compound(String) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
CONNECT_TIMEOUT - Static variable in class com.suse.salt.netapi.config.ClientConfig
Timeout in milliseconds until a connection is established.
connected() - Static method in class com.suse.salt.netapi.calls.wheel.Minions
 
Connection<T> - Interface in com.suse.salt.netapi.client
Describes an interface for different HTTP connection implementations.
ConnectionFactory - Interface in com.suse.salt.netapi.client
Describes an interface for creating instances of an HTTP connection implementation.
cpuinfo() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
cpustats() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
create(String, JsonParser<T>, ClientConfig) - Method in interface com.suse.salt.netapi.client.ConnectionFactory
Create a new Connection for a given endpoint and configuration.
create(String, JsonParser<T>, ClientConfig) - Method in class com.suse.salt.netapi.client.impl.HttpClientConnectionFactory
Create a new Connection for a given endpoint and configuration.
create(String, JsonParser<T>, ClientConfig) - Method in class com.suse.salt.netapi.client.impl.JDKConnectionFactory
Create a new Connection for a given endpoint and configuration.
custom() - Static method in class com.suse.salt.netapi.calls.modules.Status
 

D

Data<R> - Class in com.suse.salt.netapi.calls
Data field of a WheelResult.
Data() - Constructor for class com.suse.salt.netapi.calls.Data
 
delete(String) - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
delete(String) - Static method in class com.suse.salt.netapi.calls.modules.Schedule
Delete a schedule entry
delete(String) - Static method in class com.suse.salt.netapi.calls.wheel.Key
 
deniedMinions - Variable in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
disable() - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
disableBeacon(String) - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
diskstats() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
diskusage(String...) - Static method in class com.suse.salt.netapi.calls.modules.Status
 
down(boolean) - Static method in class com.suse.salt.netapi.calls.runner.Manage
 

E

enable() - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
enableBeacon(String) - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
Event - Class in com.suse.salt.netapi.calls.modules
salt.modules.event
Event - Class in com.suse.salt.netapi.datatypes
Parse events into objects.
Event() - Constructor for class com.suse.salt.netapi.datatypes.Event
 
EventListener - Interface in com.suse.salt.netapi.event
Defines a client notification interface for events stream.
events(EventListener...) - Method in class com.suse.salt.netapi.client.SaltClient
Returns a WebSocket @ClientEndpoint annotated object connected to the /ws ServerEndpoint.
EVENTS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
EventStream - Class in com.suse.salt.netapi.event
Event stream implementation based on a ClientEndpoint WebSocket.
EventStream(ClientConfig, EventListener...) - Constructor for class com.suse.salt.netapi.event.EventStream
Constructor used to create an event stream: open a websocket connection and start event processing.
eventStreamClosed(CloseReason) - Method in interface com.suse.salt.netapi.event.EventListener
Notify the listener that the backing event stream was closed.

F

fileDict(String...) - Static method in class com.suse.salt.netapi.calls.modules.Pkg
 
finger(String) - Static method in class com.suse.salt.netapi.calls.wheel.Key
 
Fingerprints() - Constructor for class com.suse.salt.netapi.calls.wheel.Key.Fingerprints
 
fire(Map<String, Object>, String) - Static method in class com.suse.salt.netapi.calls.modules.Event
 
fireMaster(Map<String, Object>, String) - Static method in class com.suse.salt.netapi.calls.modules.Event
 

G

get(ClientConfig.Key<T>) - Method in class com.suse.salt.netapi.config.ClientConfig
Returns the configured value for the given key.
get(int) - Method in class com.suse.salt.netapi.results.ResultInfoSet
Returns ResultInfo associated with a given index.
getAccepts() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getAcceptsPerSecond() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getAdditional() - Method in class com.suse.salt.netapi.event.BeaconEvent
Provides additional information from the tag depending on the type of beacon
getAddress() - Method in class com.suse.salt.netapi.calls.modules.Network.INet
 
getAddress() - Method in class com.suse.salt.netapi.calls.modules.Network.INet6
 
getApplications() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Stats
 
getArchitecture() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getArgs() - Method in class com.suse.salt.netapi.datatypes.Arguments
 
getArguments() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getArguments() - Method in class com.suse.salt.netapi.datatypes.Job
 
getArguments() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns a list of arguments supplied function.
getBeacon() - Method in class com.suse.salt.netapi.event.BeaconEvent
Returns the beacon name.
getBindAddress() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getBroadcast() - Method in class com.suse.salt.netapi.calls.modules.Network.INet
 
getBugfix() - Method in class com.suse.salt.netapi.datatypes.SaltVersion
Getter for the bugfix of this SaltVersion
getBuildDate() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getBuildDateUnixTime() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getBuildHost() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getBytesRead() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getBytesRead() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getBytesRead() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getBytesWritten() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getBytesWritten() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getBytesWritten() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getClient() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getComment() - Method in class com.suse.salt.netapi.calls.modules.Beacon.Result
 
getComment() - Method in class com.suse.salt.netapi.calls.modules.Schedule.Result
Human readable comment
getConfig() - Method in class com.suse.salt.netapi.client.SaltClient
Directly access the configuration.
getCurrentRequests() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getCurrentTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getData() - Method in class com.suse.salt.netapi.calls.modules.Smbios.Record
Get the actual data returned by smbios.records
getData() - Method in class com.suse.salt.netapi.calls.WheelResult
 
getData() - Method in class com.suse.salt.netapi.datatypes.Event
Return this event's data.
getData() - Method in class com.suse.salt.netapi.event.BeaconEvent
The event data containing more information about this event
getData() - Method in class com.suse.salt.netapi.event.JobReturnEvent
The event data containing more information about this event
getData() - Method in class com.suse.salt.netapi.event.MinionStartEvent
The event data containing more information about this event
getData() - Method in class com.suse.salt.netapi.event.ResultEvent
The event data containing more information about this event
getDate(TimeZone) - Method in class com.suse.salt.netapi.datatypes.StartTime
Returns Date representation of StartTime as parsed at a given timezone.
getDate() - Method in class com.suse.salt.netapi.datatypes.StartTime
Returns Date representation of StartTime as parsed using default timezone.
getDeniedMinions() - Method in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
getDependencies() - Method in class com.suse.salt.netapi.calls.modules.Test.VersionInformation
 
getDescription() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getDescription() - Method in class com.suse.salt.netapi.calls.modules.Smbios.Record
 
getEauth() - Method in class com.suse.salt.netapi.datatypes.Token
 
getEndTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getEpoch() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getErrors() - Method in class com.suse.salt.netapi.calls.modules.Pkg.PackageDict
 
getExpire() - Method in class com.suse.salt.netapi.datatypes.Token
 
getFun() - Method in class com.suse.salt.netapi.calls.Data
 
getFunction() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getFunction() - Method in class com.suse.salt.netapi.datatypes.Job
 
getFunction() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns function name.
getFunctionAttrs() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getFunctions() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getFunctionSubs() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getGrain() - Method in class com.suse.salt.netapi.datatypes.target.Grains
 
getGroup() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getHandle() - Method in class com.suse.salt.netapi.calls.modules.Smbios.Record
 
getHostname() - Method in class com.suse.salt.netapi.config.ProxySettings
 
getHttpServer() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Stats
 
getHWAddr() - Method in class com.suse.salt.netapi.calls.modules.Network.Interface
 
getInet() - Method in class com.suse.salt.netapi.calls.modules.Network.Interface
 
getInet6() - Method in class com.suse.salt.netapi.calls.modules.Network.Interface
 
getInfoList() - Method in class com.suse.salt.netapi.results.ResultInfoSet
Returns a list of all results.
getInstallDate() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getInstallDateUnixTime() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getInstance() - Static method in class com.suse.salt.netapi.client.impl.RequestFactory
Gets the single instance of RequestFactory.
getJid() - Method in class com.suse.salt.netapi.calls.Data
 
getJid() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getJid() - Method in class com.suse.salt.netapi.calls.ScheduledJob
 
getJid() - Method in class com.suse.salt.netapi.datatypes.ScheduledJob
 
getJid() - Method in class com.suse.salt.netapi.event.ResultEvent
The job id to which the result belongs
getJobId() - Method in class com.suse.salt.netapi.event.JobReturnEvent
The id of the job
getJobResult(ScheduledJob) - Method in class com.suse.salt.netapi.client.SaltClient
Query for the result of a supplied job.
getJobResult(String) - Method in class com.suse.salt.netapi.client.SaltClient
Query for the result of a supplied job.
getJobs() - Method in class com.suse.salt.netapi.client.SaltClient
Get previously run jobs.
getJobsAsync() - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously get previously run jobs.
getKwargs() - Method in class com.suse.salt.netapi.datatypes.Arguments
 
getLabel() - Method in class com.suse.salt.netapi.calls.modules.Network.INet
 
getLicense() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getListenerCount() - Method in class com.suse.salt.netapi.event.EventStream
Helper method that returns the current number of subscribed listeners.
getLocal() - Method in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
getMinionDetails(String) - Method in class com.suse.salt.netapi.client.SaltClient
Query for details (grains) of the specified minion.
getMinionDetailsAsync(String) - Method in class com.suse.salt.netapi.client.SaltClient
Query for details (grains) of the specified minion asynchronously.
getMinionId() - Method in class com.suse.salt.netapi.event.BeaconEvent
Returns the id of the minion that triggered the beacon
getMinionId() - Method in class com.suse.salt.netapi.event.JobReturnEvent
The id of the minion that returned the ob
getMinionId() - Method in class com.suse.salt.netapi.event.MinionStartEvent
The id of the minion that started
getMinionId() - Method in class com.suse.salt.netapi.event.ResultEvent
The id of the minion from which the result came
getMinions() - Method in class com.suse.salt.netapi.calls.LocalAsyncResult
 
getMinions() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getMinions() - Method in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
getMinions() - Method in class com.suse.salt.netapi.client.SaltClient
Query for all minions and immediately return a map of minions keyed by minion id.
getMinions() - Method in class com.suse.salt.netapi.datatypes.ScheduledJob
 
getMinions() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns set of minions this job was submitted to.
getMinionsAsync() - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously query for all minions and return a map of minions keyed by minion id.
getMissingAttrs() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getMissingSubs() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getModuleAttrs() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getModules() - Method in class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 
getMonth() - Method in class com.suse.salt.netapi.datatypes.SaltVersion
Getter for the month of this SaltVersion
getNetmask() - Method in class com.suse.salt.netapi.calls.modules.Network.INet
 
getNewFeaturesHaveBeenAdded() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getPackager() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getPackages() - Method in class com.suse.salt.netapi.calls.modules.Pkg.PackageDict
 
getPassword() - Method in class com.suse.salt.netapi.config.ProxySettings
 
getPayload() - Method in interface com.suse.salt.netapi.calls.Call
Return the call payload as a map of key/value pairs.
getPayload() - Method in class com.suse.salt.netapi.calls.LocalCall
Return the call payload as a map of key/value pairs.
getPayload() - Method in class com.suse.salt.netapi.calls.RunnerCall
Return the call payload as a map of key/value pairs.
getPayload() - Method in class com.suse.salt.netapi.calls.WheelCall
Return the call payload as a map of key/value pairs.
getPendingMinions() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns a set of minions that have yet to return a result.
getPerms() - Method in class com.suse.salt.netapi.datatypes.Token
 
getPort() - Method in class com.suse.salt.netapi.config.ProxySettings
 
getPrefixlen() - Method in class com.suse.salt.netapi.calls.modules.Network.INet6
 
getProcessingTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getQueue() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getReadsPerRequest() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getReadsPerSecond() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getReadThroughput() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getReadThroughput() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getRejectedMinions() - Method in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
getRelease() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getReleaseCandidate() - Method in class com.suse.salt.netapi.datatypes.SaltVersion
Getter for the release candidate of this SaltVersion
getRelocations() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getRequestLine() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getRequests() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getRequests() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getRequests() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getRequestsPerSecond() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getResponeStatus() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getResult() - Method in class com.suse.salt.netapi.calls.Data
 
getResult() - Method in class com.suse.salt.netapi.calls.modules.Beacon.Result
 
getResult() - Method in class com.suse.salt.netapi.calls.modules.Schedule.Result
boolean indicating success
getResult() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getResult() - Method in interface com.suse.salt.netapi.client.Connection
Send a GET request and parse the result into object of given Type.
getResult(String) - Method in interface com.suse.salt.netapi.client.Connection
Send a POST request and parse the result into object of given Type.
getResult(String) - Method in class com.suse.salt.netapi.client.impl.HttpClientConnection
Send a POST request and parse the result into object of given Type.
getResult() - Method in class com.suse.salt.netapi.client.impl.HttpClientConnection
Send a GET request and parse the result into object of given Type.
getResult(String) - Method in class com.suse.salt.netapi.client.impl.JDKConnection
Send a POST request and parse the result into object of given Type.
getResult() - Method in class com.suse.salt.netapi.client.impl.JDKConnection
Send a GET request and parse the result into object of given Type.
getResult() - Method in class com.suse.salt.netapi.results.Result
Returns the value of this result.
getResult(String) - Method in class com.suse.salt.netapi.results.ResultInfo
Returns job's return value that is associated with supplied minion as an Optional.
getResults() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns result map of available Object associated with each minion.
getReturnType() - Method in class com.suse.salt.netapi.calls.LocalCall
 
getReturnType() - Method in class com.suse.salt.netapi.calls.RunnerCall
 
getReturnType() - Method in class com.suse.salt.netapi.calls.WheelCall
 
getRunTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getSalt() - Method in class com.suse.salt.netapi.calls.modules.Test.VersionInformation
 
getScope() - Method in class com.suse.salt.netapi.calls.modules.Network.INet6
 
getServerVersion() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getSignature() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getSize() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getSocketErrors() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getSource() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getStart() - Method in class com.suse.salt.netapi.datatypes.Token
 
getStartTime(TimeZone) - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getStartTime() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getStartTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getStartTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Request
 
getStartTime(TimeZone) - Method in class com.suse.salt.netapi.datatypes.Job
Returns start time at a given TimeZone
getStartTime() - Method in class com.suse.salt.netapi.datatypes.Job
Returns start time assuming default TimeZone is Salt master's timezone.
getStartTime(TimeZone) - Method in class com.suse.salt.netapi.results.ResultInfo
Returns start time of the job.
getStartTime() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns start time assuming default TimeZone is Salt master's timezone.
getSummary() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getSummary() - Method in class com.suse.salt.netapi.calls.modules.Pkg.PackageInfo
 
getSystem() - Method in class com.suse.salt.netapi.calls.modules.Test.VersionInformation
 
getTag() - Method in class com.suse.salt.netapi.calls.Data
 
getTag() - Method in class com.suse.salt.netapi.calls.RunnerAsyncResult
 
getTag() - Method in class com.suse.salt.netapi.calls.WheelAsyncResult
 
getTag() - Method in class com.suse.salt.netapi.calls.WheelResult
 
getTag() - Method in class com.suse.salt.netapi.datatypes.Event
Return this event's tag.
getTarget() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getTarget() - Method in class com.suse.salt.netapi.datatypes.Job
 
getTarget() - Method in class com.suse.salt.netapi.datatypes.target.Glob
Return the target.
getTarget() - Method in class com.suse.salt.netapi.datatypes.target.Grains
 
getTarget() - Method in class com.suse.salt.netapi.datatypes.target.MinionList
Return the target.
getTarget() - Method in class com.suse.salt.netapi.datatypes.target.NodeGroup
Return the target.
getTarget() - Method in interface com.suse.salt.netapi.datatypes.target.Target
Return the target.
getTarget() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns target of job submission.
getTargetType() - Method in class com.suse.salt.netapi.datatypes.Job
 
getThreads() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getThreadsIdle() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getToken() - Method in class com.suse.salt.netapi.datatypes.Token
 
getTotalBytesRead() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getTotalBytesWritten() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getTotalRequests() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getTotalTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getType() - Method in class com.suse.salt.netapi.calls.modules.Smbios.Record
 
getType() - Method in enum com.suse.salt.netapi.calls.modules.Smbios.RecordType
 
getType() - Method in class com.suse.salt.netapi.calls.ScheduledJob
 
getType() - Method in class com.suse.salt.netapi.datatypes.target.Glob
Return the target type.
getType() - Method in class com.suse.salt.netapi.datatypes.target.Grains
 
getType() - Method in class com.suse.salt.netapi.datatypes.target.MinionList
Return the target type.
getType() - Method in class com.suse.salt.netapi.datatypes.target.NodeGroup
Return the target type.
getType() - Method in interface com.suse.salt.netapi.datatypes.target.Target
Return the target type.
getUnacceptedMinions() - Method in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
getUptime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getUrl() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getUser() - Method in class com.suse.salt.netapi.calls.Data
 
getUser() - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
getUser() - Method in class com.suse.salt.netapi.datatypes.Job
 
getUser() - Method in class com.suse.salt.netapi.datatypes.Token
 
getUser() - Method in class com.suse.salt.netapi.results.ResultInfo
Returns user associated with this job.
getUsername() - Method in class com.suse.salt.netapi.config.ProxySettings
 
getValue() - Method in enum com.suse.salt.netapi.AuthModule
 
getValue() - Method in enum com.suse.salt.netapi.calls.Client
 
getValue() - Method in class com.suse.salt.netapi.datatypes.target.Grains
 
getVendor() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getVersion() - Method in class com.suse.salt.netapi.calls.modules.Pkg.Info
 
getWorkerThreads() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getWorkTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getWorkTime() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getWritesPerRequest() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getWritesPerSecond() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
getWriteThroughput() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
getWriteThroughput() - Method in class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
getYear() - Method in class com.suse.salt.netapi.datatypes.SaltVersion
Getter for the year of this SaltVersion
glob(String, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
glob(String) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
Glob - Class in com.suse.salt.netapi.datatypes.target
Target for specifying minions by glob pattern.
Glob() - Constructor for class com.suse.salt.netapi.datatypes.target.Glob
Default constructor.
Glob(String) - Constructor for class com.suse.salt.netapi.datatypes.target.Glob
Constructor expecting a glob pattern as string.
grain(String, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
Grains - Class in com.suse.salt.netapi.calls.modules
salt.modules.grains
Grains - Class in com.suse.salt.netapi.datatypes.target
Matcher based on salt grains
Grains(String, String) - Constructor for class com.suse.salt.netapi.datatypes.target.Grains
Creates a grains matcher

H

hasValue(String) - Static method in class com.suse.salt.netapi.calls.modules.Grains
 
HttpClientConnection<T> - Class in com.suse.salt.netapi.client.impl
Class representation of a connection to Salt for issuing API requests using Apache's HttpClient.
HttpClientConnection(String, JsonParser<T>, ClientConfig) - Constructor for class com.suse.salt.netapi.client.impl.HttpClientConnection
Init a connection to a given Salt API endpoint.
HttpClientConnectionFactory - Class in com.suse.salt.netapi.client.impl
Implementation of a factory for connections using Apache's HttpClient.
HttpClientConnectionFactory() - Constructor for class com.suse.salt.netapi.client.impl.HttpClientConnectionFactory
 
HttpServer - Class in com.suse.salt.netapi.datatypes.cherrypy
Representation of HTTP server statistics.
HttpServer() - Constructor for class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 

I

INet() - Constructor for class com.suse.salt.netapi.calls.modules.Network.INet
 
INet6() - Constructor for class com.suse.salt.netapi.calls.modules.Network.INet6
 
Info() - Constructor for class com.suse.salt.netapi.calls.modules.Pkg.Info
 
Info() - Constructor for class com.suse.salt.netapi.calls.runner.Jobs.Info
 
infoAvailable(String...) - Static method in class com.suse.salt.netapi.calls.modules.Pkg
 
infoInstalled(List<String>, boolean, String...) - Static method in class com.suse.salt.netapi.calls.modules.Pkg
Call 'pkg.info_installed' API.
initConnection(String, String, ClientConfig) - Method in class com.suse.salt.netapi.client.impl.RequestFactory
Init a HttpURLConnection object from a given URI.
install(boolean, List<String>) - Static method in class com.suse.salt.netapi.calls.modules.Pkg
Call 'pkg.install' API.
Interface() - Constructor for class com.suse.salt.netapi.calls.modules.Network.Interface
 
interfaces() - Static method in class com.suse.salt.netapi.calls.modules.Network
 
isEnable() - Method in class com.suse.salt.netapi.datatypes.cherrypy.HttpServer
 
isEnabled() - Method in class com.suse.salt.netapi.datatypes.cherrypy.Applications
 
isEventStreamClosed() - Method in class com.suse.salt.netapi.event.EventStream
Helper method to check if the WebSocket Session exists and is open.
isSuccess() - Method in class com.suse.salt.netapi.calls.Data
 
isUp() - Method in class com.suse.salt.netapi.calls.modules.Network.Interface
 
item(boolean, String...) - Static method in class com.suse.salt.netapi.calls.modules.Grains
 
items(boolean) - Static method in class com.suse.salt.netapi.calls.modules.Grains
 
iterator() - Method in class com.suse.salt.netapi.results.ResultInfoSet
Returns an iterator to the ResultInfo collection.

J

JDKConnection<T> - Class in com.suse.salt.netapi.client.impl
Class representation of a connection to Salt for issuing API requests using JDK's HttpURLConnection.
JDKConnection(String, JsonParser<T>, ClientConfig) - Constructor for class com.suse.salt.netapi.client.impl.JDKConnection
Init a connection to a given Salt API endpoint.
JDKConnectionFactory - Class in com.suse.salt.netapi.client.impl
Implementation of a factory for connections using JDK's HttpURLConnection.
JDKConnectionFactory() - Constructor for class com.suse.salt.netapi.client.impl.JDKConnectionFactory
 
Job - Class in com.suse.salt.netapi.datatypes
Representation of a previously run job.
Job() - Constructor for class com.suse.salt.netapi.datatypes.Job
 
JOB_RESULTS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
JobReturnEvent - Class in com.suse.salt.netapi.event
Representation of job return events fired each time a minion returns data for a job.
JobReturnEvent(String, String, Map<String, Object>) - Constructor for class com.suse.salt.netapi.event.JobReturnEvent
Creates a new JobReturnEvent
Jobs - Class in com.suse.salt.netapi.calls.runner
salt.runners.jobs
JOBS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
Jobs.Info<R> - Class in com.suse.salt.netapi.calls.runner
Information about a salt job as returned by 'jobs.list_job' and 'jobs.print_job'.
JsonParser<T> - Class in com.suse.salt.netapi.parser
Parser for Salt API responses.
JsonParser(TypeToken<T>) - Constructor for class com.suse.salt.netapi.parser.JsonParser
Created a new JsonParser for the given type.

K

Key - Class in com.suse.salt.netapi.calls.wheel
salt.wheel.key
Key.Fingerprints - Class in com.suse.salt.netapi.calls.wheel
Matching key fingerprints as returned by "key.finger".
Key.Keys<T> - Class in com.suse.salt.netapi.calls.wheel
Salt keys information.
Key.Names - Class in com.suse.salt.netapi.calls.wheel
Salt keys as returned by "key.list_all".
Keys() - Constructor for class com.suse.salt.netapi.calls.wheel.Key.Keys
 
keys() - Method in class com.suse.salt.netapi.client.SaltClient
Query general key information.
KEYS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
keysAsync() - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously query general key information.

L

list() - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
list(List<String>, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
list(String...) - Static method in class com.suse.salt.netapi.calls.modules.Match
 
listAll() - Static method in class com.suse.salt.netapi.calls.wheel.Key
 
listPkgs() - Static method in class com.suse.salt.netapi.calls.modules.Pkg
 
loadavg() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
local - Variable in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
LocalAsyncResult<R> - Class in com.suse.salt.netapi.calls
Result of calling a execution module function asynchronously.
LocalAsyncResult() - Constructor for class com.suse.salt.netapi.calls.LocalAsyncResult
 
LocalCall<R> - Class in com.suse.salt.netapi.calls
Class representing a function call of a salt execution module.
LocalCall(String, Optional<List<?>>, Optional<Map<String, ?>>, TypeToken<R>) - Constructor for class com.suse.salt.netapi.calls.LocalCall
 
login(String, String, AuthModule) - Method in class com.suse.salt.netapi.client.SaltClient
Perform login and return the token.
loginAsync(String, String, AuthModule) - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously perform login and return a Future with the token.
logout() - Method in class com.suse.salt.netapi.client.SaltClient
Perform logout and clear the session token from the config.
logoutAsync() - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously perform logout and clear the session token from the config.
lookupJid(String) - Static method in class com.suse.salt.netapi.calls.runner.Jobs
 
lookupJid(LocalAsyncResult<R>) - Static method in class com.suse.salt.netapi.calls.runner.Jobs
 
lookupJid(WheelAsyncResult<R>) - Static method in class com.suse.salt.netapi.calls.runner.Jobs
 
lookupJid(RunnerAsyncResult<R>) - Static method in class com.suse.salt.netapi.calls.runner.Jobs
 
ls() - Static method in class com.suse.salt.netapi.calls.modules.Grains
 

M

Manage - Class in com.suse.salt.netapi.calls.runner
salt.runners.manage
MAP - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
Match - Class in com.suse.salt.netapi.calls.modules
salt.modules.match
Match() - Constructor for class com.suse.salt.netapi.calls.modules.Match
 
meminfo() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
MessageTooBigException - Exception in com.suse.salt.netapi.exception
Exception to be thrown in case of a websocket message exceeding the configurable maximum message length.
MessageTooBigException(int) - Constructor for exception com.suse.salt.netapi.exception.MessageTooBigException
Constructor.
MinionList - Class in com.suse.salt.netapi.datatypes.target
Target for specifying a list of minions.
MinionList(List<String>) - Constructor for class com.suse.salt.netapi.datatypes.target.MinionList
Constructor taking a list of minions as strings.
MinionList(String...) - Constructor for class com.suse.salt.netapi.datatypes.target.MinionList
Constructor taking an optional list of strings.
minions - Variable in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
Minions - Class in com.suse.salt.netapi.calls.wheel
salt.wheel.minions
MinionStartEvent - Class in com.suse.salt.netapi.event
Represents an event fired when a minion connects to the salt master
MinionStartEvent(String, Map<String, Object>) - Constructor for class com.suse.salt.netapi.event.MinionStartEvent
Creates a new MinionStartEvent
modify(String, Map<String, Object>) - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
moduleReport() - Static method in class com.suse.salt.netapi.calls.modules.Test
 
ModuleReport(List<String>, List<String>, List<String>, List<String>, List<String>, List<String>, List<String>) - Constructor for class com.suse.salt.netapi.calls.modules.Test.ModuleReport
 

N

Names() - Constructor for class com.suse.salt.netapi.calls.wheel.Key.Names
 
netdev() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
netstats() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
Network - Class in com.suse.salt.netapi.calls.modules
salt.modules.network
Network.INet - Class in com.suse.salt.netapi.calls.modules
Network interface as returned by "network.interfaces".
Network.INet6 - Class in com.suse.salt.netapi.calls.modules
Network interface (IPv6) as returned by "network.interfaces".
Network.Interface - Class in com.suse.salt.netapi.calls.modules
Network interface as returned by "network.interfaces".
NodeGroup - Class in com.suse.salt.netapi.datatypes.target
Target for referencing a nodegroup.
NodeGroup(String) - Constructor for class com.suse.salt.netapi.datatypes.target.NodeGroup
Constructor expecting a nodegroup as string.
notify(Event) - Method in interface com.suse.salt.netapi.event.EventListener
Notify the listener of a new event.
nproc() - Static method in class com.suse.salt.netapi.calls.modules.Status
 

O

onClose(Session, CloseReason) - Method in class com.suse.salt.netapi.event.EventStream
On closing the websocket, refresh the session and notify all subscribed listeners.
onError(Throwable) - Method in class com.suse.salt.netapi.event.EventStream
On error, convert Throwable into CloseReason and close the session.
onMessage(String, boolean) - Method in class com.suse.salt.netapi.event.EventStream
Notify listeners on each event received on the websocket and buffer partial messages.
onOpen(Session, EndpointConfig) - Method in class com.suse.salt.netapi.event.EventStream
On handshake completed, get the WebSocket Session and send a message to ServerEndpoint that WebSocket is ready.

P

PackageDict() - Constructor for class com.suse.salt.netapi.calls.modules.Pkg.PackageDict
 
PackageInfo() - Constructor for class com.suse.salt.netapi.calls.modules.Pkg.PackageInfo
 
parameterizedType(Type, Type, Type...) - Static method in class com.suse.salt.netapi.utils.ClientUtils
Helper for constructing parameterized types.
parse(String) - Static method in class com.suse.salt.netapi.datatypes.SaltVersion
Parses a salt version string
parse(Event) - Static method in class com.suse.salt.netapi.event.BeaconEvent
Utility method to parse e generic event to a more specific one
parse(Event) - Static method in class com.suse.salt.netapi.event.JobReturnEvent
Utility method to parse a generic event into a more specific one.
parse(Event) - Static method in class com.suse.salt.netapi.event.MinionStartEvent
Utility method to parse e generic event to a more specific one
parse(Event) - Static method in class com.suse.salt.netapi.event.ResultEvent
Utility method to parse e generic event to a more specific one
parse(InputStream) - Method in class com.suse.salt.netapi.parser.JsonParser
Parses a Json response that has a direct representation as a Java class.
parse(String) - Method in class com.suse.salt.netapi.parser.JsonParser
Parse JSON given as string.
ParsingException - Exception in com.suse.salt.netapi.exception
Exception to be thrown in case of problems parsing service responses.
ParsingException(Throwable) - Constructor for exception com.suse.salt.netapi.exception.ParsingException
Constructor expecting a custom cause.
ParsingException(String) - Constructor for exception com.suse.salt.netapi.exception.ParsingException
Constructor expecting a custom message.
pid(String) - Static method in class com.suse.salt.netapi.calls.modules.Status
 
ping() - Static method in class com.suse.salt.netapi.calls.modules.Test
 
Pkg - Class in com.suse.salt.netapi.calls.modules
salt.modules.pkg
Pkg.Info - Class in com.suse.salt.netapi.calls.modules
Information about a package as returned by pkg.info_installed and pkg.info_available
Pkg.PackageDict - Class in com.suse.salt.netapi.calls.modules
Package dictionary as returned by "pkg.file_dict".
Pkg.PackageInfo - Class in com.suse.salt.netapi.calls.modules
Information about a package as returned by "pkg.search".
present(Optional<String>, Optional<Boolean>) - Static method in class com.suse.salt.netapi.calls.runner.Manage
 
present() - Static method in class com.suse.salt.netapi.calls.runner.Manage
 
procs() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
provider(String) - Static method in class com.suse.salt.netapi.calls.modules.Test
 
providers() - Static method in class com.suse.salt.netapi.calls.modules.Test
 
PROXY_HOSTNAME - Static variable in class com.suse.salt.netapi.config.ClientConfig
 
PROXY_PASSWORD - Static variable in class com.suse.salt.netapi.config.ClientConfig
 
PROXY_PORT - Static variable in class com.suse.salt.netapi.config.ClientConfig
 
PROXY_USERNAME - Static variable in class com.suse.salt.netapi.config.ClientConfig
 
ProxySettings - Class in com.suse.salt.netapi.config
Class representing proxy settings to be used with SaltClient.
ProxySettings(String, int) - Constructor for class com.suse.salt.netapi.config.ProxySettings
Basic constructor taking proxy hostname and port.
ProxySettings(String, int, String, String) - Constructor for class com.suse.salt.netapi.config.ProxySettings
Extended constructor supporting proxies with authentication.
put(ClientConfig.Key<T>, T) - Method in class com.suse.salt.netapi.config.ClientConfig
Sets the config for a key to the specified value.

R

Record() - Constructor for class com.suse.salt.netapi.calls.modules.Smbios.Record
 
records(Smbios.RecordType) - Static method in class com.suse.salt.netapi.calls.modules.Smbios
smbios.records
reject(String) - Static method in class com.suse.salt.netapi.calls.wheel.Key
 
rejectedMinions - Variable in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
remove(ClientConfig.Key<T>) - Method in class com.suse.salt.netapi.config.ClientConfig
Removes the value for the specified key.
removeEventListener(EventListener) - Method in class com.suse.salt.netapi.event.EventStream
Request - Class in com.suse.salt.netapi.datatypes.cherrypy
Representation of request statistics.
Request() - Constructor for class com.suse.salt.netapi.datatypes.cherrypy.Request
 
RequestFactory - Class in com.suse.salt.netapi.client.impl
Helper class for setting up HttpURLConnection objects.
Result(String, boolean) - Constructor for class com.suse.salt.netapi.calls.modules.Beacon.Result
 
Result(String, boolean) - Constructor for class com.suse.salt.netapi.calls.modules.Schedule.Result
Construct a new Result
Result<T> - Class in com.suse.salt.netapi.results
Represents a Salt API result.
Result() - Constructor for class com.suse.salt.netapi.results.Result
 
ResultEvent - Class in com.suse.salt.netapi.event
Represents an event containing the result of some function call
ResultEvent(String, String, Map<String, Object>) - Constructor for class com.suse.salt.netapi.event.ResultEvent
Creates a new ResultEvent
ResultInfo - Class in com.suse.salt.netapi.results
Represents the Salt API's result information structure.
ResultInfo() - Constructor for class com.suse.salt.netapi.results.ResultInfo
 
ResultInfoSet - Class in com.suse.salt.netapi.results
Holds a result set of a running job.
ResultInfoSet() - Constructor for class com.suse.salt.netapi.results.ResultInfoSet
 
resultOf(String) - Method in class com.suse.salt.netapi.calls.runner.Jobs.Info
 
RETMAPS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
run(String) - Static method in class com.suse.salt.netapi.calls.modules.Cmd
 
run(String, String, AuthModule, String, Target<T>, String, List<Object>, Map<String, Object>) - Method in class com.suse.salt.netapi.client.SaltClient
Generic interface to start any execution command bypassing normal session handling.
RUN_RESULTS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
runAsync(String, String, AuthModule, String, Target<T>, String, List<Object>, Map<String, Object>) - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously start any execution command bypassing normal session handling.
RunnerAsyncResult<R> - Class in com.suse.salt.netapi.calls
Result of calling a runner module function asynchronously.
RunnerAsyncResult() - Constructor for class com.suse.salt.netapi.calls.RunnerAsyncResult
 
RunnerCall<R> - Class in com.suse.salt.netapi.calls
Class representing a function call of a salt runner module.
RunnerCall(String, Optional<Map<String, ?>>, TypeToken<R>) - Constructor for class com.suse.salt.netapi.calls.RunnerCall
 

S

SaltClient - Class in com.suse.salt.netapi.client
Salt API client.
SaltClient(URI) - Constructor for class com.suse.salt.netapi.client.SaltClient
Constructor for connecting to a given URL.
SaltClient(URI, ConnectionFactory) - Constructor for class com.suse.salt.netapi.client.SaltClient
Constructor for connecting to a given URL using a specific connection factory.
SaltClient(URI, ExecutorService) - Constructor for class com.suse.salt.netapi.client.SaltClient
Constructor for connecting to a given URL.
SaltClient(URI, ConnectionFactory, ExecutorService) - Constructor for class com.suse.salt.netapi.client.SaltClient
Constructor for connecting to a given URL using a specific connection factory.
SaltException - Exception in com.suse.salt.netapi.exception
Exception to be thrown in case of problems with Salt.
SaltException(Throwable) - Constructor for exception com.suse.salt.netapi.exception.SaltException
Constructor expecting a custom cause.
SaltException(String) - Constructor for exception com.suse.salt.netapi.exception.SaltException
Constructor expecting a custom message.
SaltUserUnauthorizedException - Exception in com.suse.salt.netapi.exception
Exception for when a user is logged in but not allowed access to the requested resource.
SaltUserUnauthorizedException(String) - Constructor for exception com.suse.salt.netapi.exception.SaltUserUnauthorizedException
 
SaltUtil - Class in com.suse.salt.netapi.calls.modules
salt.modules.saltutil
SaltUtil() - Constructor for class com.suse.salt.netapi.calls.modules.SaltUtil
 
SaltVersion - Class in com.suse.salt.netapi.datatypes
Represents a salt version
SaltVersion(int, int, int, Optional<Integer>) - Constructor for class com.suse.salt.netapi.datatypes.SaltVersion
Creates a SaltVersion
SaltVersion(int, int, int, int) - Constructor for class com.suse.salt.netapi.datatypes.SaltVersion
Creates a SaltVersion
SaltVersion(int, int, int) - Constructor for class com.suse.salt.netapi.datatypes.SaltVersion
Creates a SaltVersion without release candidate tag
save() - Static method in class com.suse.salt.netapi.calls.modules.Beacon
 
Schedule - Class in com.suse.salt.netapi.calls.modules
salt.modules.schedule
Schedule.Result - Class in com.suse.salt.netapi.calls.modules
Common result structure for scheduling functions
SCHEDULED_JOB - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
ScheduledJob<R> - Class in com.suse.salt.netapi.calls
Common class representing a scheduled job.
ScheduledJob() - Constructor for class com.suse.salt.netapi.calls.ScheduledJob
 
ScheduledJob - Class in com.suse.salt.netapi.datatypes
Representation of a scheduled job (not finished yet).
ScheduledJob() - Constructor for class com.suse.salt.netapi.datatypes.ScheduledJob
 
search(String) - Static method in class com.suse.salt.netapi.calls.modules.Pkg
 
sendEvent(String, String) - Method in class com.suse.salt.netapi.client.SaltClient
Trigger an event in Salt with the specified tag and data.
sendEventAsync(String, String) - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously trigger an event in Salt with the specified tag and data.
ServerThread - Class in com.suse.salt.netapi.datatypes.cherrypy
Representation of server thread statistics.
ServerThread() - Constructor for class com.suse.salt.netapi.datatypes.cherrypy.ServerThread
 
setHostname(String) - Method in class com.suse.salt.netapi.config.ProxySettings
 
setPassword(String) - Method in class com.suse.salt.netapi.config.ProxySettings
 
setPort(int) - Method in class com.suse.salt.netapi.config.ProxySettings
 
setProxy(ProxySettings) - Method in class com.suse.salt.netapi.client.SaltClient
Configure to use a proxy when connecting to the Salt API.
setType(TypeToken<R>) - Method in class com.suse.salt.netapi.calls.ScheduledJob
 
setUsername(String) - Method in class com.suse.salt.netapi.config.ProxySettings
 
size() - Method in class com.suse.salt.netapi.results.ResultInfoSet
Returns result set size.
Smbios - Class in com.suse.salt.netapi.calls.modules
salt.modules.smbios
Smbios.Record - Class in com.suse.salt.netapi.calls.modules
Holds the information returned by smbios.records
Smbios.RecordType - Enum in com.suse.salt.netapi.calls.modules
The type of the dmi records.
SOCKET_TIMEOUT - Static variable in class com.suse.salt.netapi.config.ClientConfig
Timeout in milliseconds for waiting for data.
startCommand(Target<T>, String, List<Object>, Map<String, Object>) - Method in class com.suse.salt.netapi.client.SaltClient
Generic interface to start any execution command and immediately return an object representing the scheduled job.
startCommandAsync(Target<T>, String, List<Object>, Map<String, Object>) - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously start any execution command and immediately return an object representing the scheduled job.
StartTime - Class in com.suse.salt.netapi.datatypes
StartDate is a convenience wrapper allowing for parsing of StartDate in the timezone appropriate to a given master.
StartTime(String) - Constructor for class com.suse.salt.netapi.datatypes.StartTime
Construct a StartTime from a date given as string.
State - Class in com.suse.salt.netapi.calls.modules
salt.modules.state
stats() - Method in class com.suse.salt.netapi.client.SaltClient
Query statistics from the CherryPy Server.
Stats - Class in com.suse.salt.netapi.datatypes.cherrypy
Representation of CherryPy server statistics.
Stats(Applications, HttpServer) - Constructor for class com.suse.salt.netapi.datatypes.cherrypy.Stats
 
STATS - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
statsAsync() - Method in class com.suse.salt.netapi.client.SaltClient
Asynchronously query statistics from the CherryPy Server.
Status - Class in com.suse.salt.netapi.calls.modules
salt.modules.status
streamToString(InputStream) - Static method in class com.suse.salt.netapi.utils.ClientUtils
Convert a given InputStream to a String.
STRING - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
stringToStream(String) - Static method in class com.suse.salt.netapi.utils.ClientUtils
Convert a given String to an InputStream.
syncAll(Optional<Boolean>, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.SaltUtil
 
syncGrains(Optional<Boolean>, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.SaltUtil
 
syncModules(Optional<Boolean>, Optional<String>) - Static method in class com.suse.salt.netapi.calls.modules.SaltUtil
 

T

Target<T> - Interface in com.suse.salt.netapi.datatypes.target
Target interface for specifying a group of minions.
Test - Class in com.suse.salt.netapi.calls.modules
salt.modules.test
Test() - Constructor for class com.suse.salt.netapi.calls.modules.Test
 
Test.ModuleReport - Class in com.suse.salt.netapi.calls.modules
Availability report of all execution modules
Test.VersionInformation - Class in com.suse.salt.netapi.calls.modules
Version report of dependent and system software
TOKEN - Static variable in class com.suse.salt.netapi.config.ClientConfig
 
Token - Class in com.suse.salt.netapi.datatypes
Token containing authentication data.
Token() - Constructor for class com.suse.salt.netapi.datatypes.Token
 
TOKEN - Static variable in class com.suse.salt.netapi.parser.JsonParser
 
toString() - Method in class com.suse.salt.netapi.datatypes.Arguments
 
toString() - Method in class com.suse.salt.netapi.datatypes.SaltVersion
 
toString() - Method in class com.suse.salt.netapi.datatypes.StartTime
Returns a string representation of StartTime.

U

unacceptedMinions - Variable in class com.suse.salt.netapi.calls.wheel.Key.Keys
 
up() - Static method in class com.suse.salt.netapi.calls.runner.Manage
 
uptime() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
URL - Static variable in class com.suse.salt.netapi.config.ClientConfig
 

V

valueOf(String) - Static method in enum com.suse.salt.netapi.AuthModule
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.suse.salt.netapi.calls.Client
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.suse.salt.netapi.calls.modules.Smbios.RecordType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.suse.salt.netapi.AuthModule
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.suse.salt.netapi.calls.Client
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.suse.salt.netapi.calls.modules.Smbios.RecordType
Returns an array containing the constants of this enum type, in the order they are declared.
version() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
VersionInformation(Map<String, String>, Map<String, String>, Map<String, String>) - Constructor for class com.suse.salt.netapi.calls.modules.Test.VersionInformation
 
versionsInformation() - Static method in class com.suse.salt.netapi.calls.modules.Test
 
vmstats() - Static method in class com.suse.salt.netapi.calls.modules.Status
 

W

w() - Static method in class com.suse.salt.netapi.calls.modules.Status
 
WEBSOCKET_MAX_MESSAGE_LENGTH - Static variable in class com.suse.salt.netapi.config.ClientConfig
Maximum websocket message length in characters.
WheelAsyncResult<R> - Class in com.suse.salt.netapi.calls
Result of calling a wheel module function asynchronously.
WheelAsyncResult() - Constructor for class com.suse.salt.netapi.calls.WheelAsyncResult
 
WheelCall<R> - Class in com.suse.salt.netapi.calls
Class representing a function call of a salt wheel module.
WheelCall(String, Optional<Map<String, ?>>, TypeToken<R>) - Constructor for class com.suse.salt.netapi.calls.WheelCall
 
WheelResult<R> - Class in com.suse.salt.netapi.calls
Wrapper around the wheel functions return type.
WheelResult() - Constructor for class com.suse.salt.netapi.calls.WheelResult
 
A B C D E F G H I J K L M N O P R S T U V W 
Skip navigation links

Copyright © 2016. All rights reserved.