ApplicationParameter
¶
An ApplicationParameter describe a single input parameter to an Application.
sealed class ApplicationParameter {
abstract val defaultValue: Any?
abstract val description: String
abstract val name: String
abstract val optional: Boolean
abstract val title: String?
class Bool : ApplicationParameter()
class Enumeration : ApplicationParameter()
class FloatingPoint : ApplicationParameter()
class Ingress : ApplicationParameter()
class InputDirectory : ApplicationParameter()
class InputFile : ApplicationParameter()
class Integer : ApplicationParameter()
class LicenseServer : ApplicationParameter()
class NetworkIP : ApplicationParameter()
class Peer : ApplicationParameter()
class Text : ApplicationParameter()
class TextArea : ApplicationParameter()
}
All ApplicationParameter
s contain metadata used for the presentation in the frontend. This metadata
includes a title and help-text. This allows UCloud to create a rich user-interface with widgets which are easy to
use.
When the user requests the creation of a Job
, they supply a lot of
information. This includes a reference to the Application
and a set of AppParameterValue
s.
The user must supply a value for every mandatory ApplicationParameter
. Every parameter has a type
associated with it. This type controls the set of valid AppParameterValue
s it can take.