All Classes

Class	Description
AbstractCall<R>	Abstract class for all function calls in salt.
AbstractEventStream	Implements basic listener bookkeeping for EventStream.
AbstractTarget<T>	Base class for all target types
Adapters	Strict null rejecting primitive type adapters.
Applications	Representation of applications statistics.
Arguments	Representation of args and kwargs.
ArgumentsAdapter	Json TypeAdapter for Arguments class.
AsyncHttpClient	Simple abstraction over async http operations needed by the salt client.
AuthMethod	Datatype holding data for authentication which can either be password based or token based.
AuthModule	Salt authentication modules.
Batch	A class representing the batch parameter.
Batch.BatchBuilder	Helper class for building a Batch.
BatchStartedEvent	Represents an event fired when a batch job starts.
BatchStartedEvent.Data	Data object of the batch started event
Beacon	salt.modules.beacons
Beacon.Result	Status result of many beacon functions
BeaconEvent	Represents an event fired by beacons
Call<R>	Interface for all function calls in salt.
Change<T>	Represents a change from some old value to a new one.
Client	Possible values for the client parameter in salt netapi calls.
ClientUtils	Utilities for SaltClient.
Cmd	salt.modules.cmdmod
CmdResult	Result structure as returned by cmd.exec_code_all, cmd.run_all, cmd.script to be parsed from event data.
CollectionTypeAdapterFactory	Adapt a homogeneous collection of objects.
CollectionTypeAdapterFactory.Adapter<E>	Adapter for the Collections.
Compound	Target for specifying minions by compound expression.
Config	Returns configuration information from minions.
Data<R>	Data field of a WheelResult.
DateAdapter	TypeAdapter for date representation received from the API (which represents it as a (floating) number of seconds since the Epoch).
DictionaryTarget	Base class for all grain and pillar target types
EngineEvent	Represents an event fired by engines
Event	salt.modules.event
Event	salt.runners.event
Event	Parse events into objects.
EventListener	Defines a client notification interface for events stream.
EventStream	Represents a container of listener to Event; for each message a bunch of EventListener will be recalled and notified with it.
File	Basic operations on files and directories on minions
File.Result	File module result object
FunctionE<T,R>	Like java.util.function.Function but can throw SaltException
FunctionNotAvailable	Salt error when trying to execute a function that does not exist
GenericError	Catch all error that contains only a error messages.
Git	salt.modules.git
GitResult	Result structure as returned by git status.
Glob	Target for specifying minions by glob pattern.
Grains	salt.modules.grains
Grains	Matcher based on salt grains
GrainsRegEx	Matcher based on salt grains
HashType	The type of hash based on Python hashlib - only always supported types.
HttpAsyncClientImpl	AsyncHttpClient implemented with Apache's HttpAsyncClient.
HttpClientUtils	Helpers for creating an async http client
HttpServer	Representation of HTTP server statistics.
IPCidr	Target for specifying minions by IP CIDR.
JobReturnEvent	Representation of job return events fired each time a minion returns data for a job.
JobReturnEvent.Data	Data object of the job return event
Jobs	salt.runners.jobs
Jobs.Info	Information about a salt job as returned by 'jobs.list_job'
Jobs.ListJobsEntry	Result entry of jobs.list_jobs
JsonParser<T>	Parser for Salt API responses.
JsonParsingError	Json parsing error that contains the rest of the json which could not be parsed.
Key	salt.wheel.key
Key.Fingerprints	Matching key fingerprints as returned by "key.finger".
Key.Keys<T>	Salt keys information.
Key.Names	Salt keys as returned by "key.list_all".
Key.Pair	A key pair as returned by "key.gen" or "key.gen_accept".
LocalAsyncResult<R>	Result of calling a execution module function asynchronously.
LocalCall<R>	Class representing a function call of a salt execution module.
LocalDateTimeISOAdapter	Adapter to convert an ISO formatted string to LocalDateTime
Locate	salt.modules.locate Module for using the mlocate utilities.
Locate.LocateOpts	All possible options for "locate" method.
Locate.Stats	Locate module result object
Manage	salt.runners.manage
Match	salt.modules.match
MessageTooBigException	Exception to be thrown in case of a websocket message exceeding the configurable maximum message length.
Minion	salt.modules.minion https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.minion.html
MinionList	Target for specifying a list of minions.
Minions	salt.wheel.minions
MinionStartEvent	Represents an event fired when a minion connects to the salt master
ModuleNotSupported	Error that happens if a modules is not supported
ModuleRun<R>	result of a module.run in a state file
Network	salt.modules.network
Network.INet	Network interface as returned by "network.interfaces".
Network.INet6	Network interface (IPv6) as returned by "network.interfaces".
Network.Interface	Network interface as returned by "network.interfaces".
NodeGroup	Target for referencing a nodegroup.
Openscap	salt.modules.openscap
Openscap.OpenscapResult	openscap.xccdf result.
OptionalTypeAdapterFactory	TypeAdaptorFactory creating TypeAdapters for Optional
ParsingException	Exception to be thrown in case of problems parsing service responses.
PasswordAuth	Datatype for holding all data needed for password authentication
PatternInfo	Information about a pattern as returned by "pkg.list_patterns".
Pillar	Matcher based on salt pillar with glob matching
PillarExact	Matcher based on salt pillar without glob matching
PillarRegEx	Matcher based on salt pillar with regular expression matching
Pkg	salt.modules.pkg
Pkg.Info	Information about a package as returned by pkg.info_installed and pkg.info_available
Pkg.PackageDict	Package dictionary as returned by "pkg.file_dict".
Pkg.PackageInfo	Information about a package as returned by "pkg.search".
Range	Target for specifying minions by range expression.
RegEx	Target for specifying minions by regular expression.
Request	Representation of request statistics.
Result<R>	Representation of call results for a single minion implemented as a wrapper around Xor.
ResultEvent	Represents an event containing the result of some function call
ResultSSHResultTypeAdapterFactory	TypeAdapterFactory for creating type adapters for parsing wrapped Result<SSHResult> objects.
ResultTypeAdapterFactory	TypeAdapterFactory for creating type adapters for parsing Result objects.
Ret<T>	Wrapper object representing a "ret" element to be parsed from event data.
Return<T>	Represents a Salt API result.
RunnerAsyncResult<R>	Result of calling a runner module function asynchronously.
RunnerCall<R>	Class representing a function call of a salt runner module.
RunnerReturnEvent	Representation of job return events fired each time a minion returns data for a job.
RunnerReturnEvent.Data	Data object of the job return event
SaltClient	Salt API client.
SaltError	Interface for all salt related errors
SaltErrorUtils	Utils for deriving SaltError based on the salt text output.
SaltException	Exception to be thrown in case of problems with Salt.
SaltSSHConfig	Salt SSH configuration with a builder class.
SaltSSHConfig.Builder	Builder class to create configurations for Salt SSH.
SaltSSHError	Interface for salt ssh specific errors
SaltSSHUtils	Salt SSH utility class with shared methods.
SaltUserUnauthorizedException	Exception for when a user is logged in but not allowed access to the requested resource.
SaltUtil	salt.modules.saltutil
SaltUtil.RunningInfo	Info about a running job on a minion
SaltVersion	Represents a salt version
Schedule	salt.modules.schedule
Schedule.Result	Common result structure for scheduling functions
ScheduledJob<R>	Common class representing a scheduled job.
ServerThread	Representation of server thread statistics.
Smbios	salt.modules.smbios
Smbios.Record	Holds the information returned by smbios.records
Smbios.RecordType	The type of the dmi records.
SSHRawResult	Wrapper class for salt-ssh raw calls results.
SSHResult<T>	Wrapper class for salt-ssh results.
SSHTarget<T>	Target interface for specifying a group of minions.
StartTime	StartDate is a convenience wrapper allowing for parsing of StartDate in the timezone appropriate to a given master.
StartTimeAdapter	Json adapter to handle the Job.StartTime date format given by netapi
State	salt.modules.state
State.ApplyResult	Result type for state.apply
StateApplyResult<R>	Result structure as returned by state.apply to be parsed from event data.
Stats	Representation of CherryPy server statistics.
StatsAdapter	Json TypeAdapter for the Stats object received from the API.
Status	salt.modules.status
System	salt.modules.system https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.system.html
Target<T>	Target interface for specifying a group of minions.
TargetType	Possible values for the tgt_type parameter in salt netapi calls.
Test	salt.modules.test
Test.ModuleReport	Availability report of all execution modules
Test.VersionInformation	Version report of dependent and system software
Timezone	salt.modules.timezone https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.timezone.html
Token	Token containing authentication data.
TransactionalUpdate	salt.modules.transactional_update https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.transactional_update.html
WebSocketEventStream	Event stream implementation based on a ClientEndpoint WebSocket.
WheelAsyncResult<R>	Result of calling a wheel module function asynchronously.
WheelCall<R>	Class representing a function call of a salt wheel module.
WheelResult<R>	Wrapper around the wheel functions return type.
Xor<L,R>	Right biased disjunction mainly based on the Xor type from scala cats library.
Xor.Left<L,R>	Left branch of the Xor
Xor.Right<L,R>	Right branch of the Xor
XorTypeAdapterFactory	TypeAdaptorFactory creating TypeAdapters for Xor
ZonedDateTimeISOAdapter	Adapter to convert an ISO formatted string to ZonedDateTime
Zypper	salt.modules.zypper https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.zypper.html
Zypper.ProductInfo	The product information as returned by listProducts().