DataSourceParameter class

Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.

Constructors

DataSourceParameter()
DataSourceParameter.fromJson(Map _json)

Properties

allowedValues List<String>
All possible values for the parameter.
read / write
deprecated bool
If true, it should not be used in new transfers, and it should not be visible to users.
read / write
description String
Parameter description.
read / write
displayName String
Parameter display name in the user interface.
read / write
fields List<DataSourceParameter>
Deprecated. This field has no effect.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
immutable bool
Cannot be changed after initial creation.
read / write
maxValue double
For integer and double values specifies maxminum allowed value.
read / write
minValue double
For integer and double values specifies minimum allowed value.
read / write
paramId String
Parameter identifier.
read / write
recurse bool
Deprecated. This field has no effect.
read / write
repeated bool
Deprecated. This field has no effect.
read / write
required bool
Is parameter required.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
type String
Parameter type. Possible string values are: [...]
read / write
validationDescription String
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
read / write
validationHelpUrl String
URL to a help document to further explain the naming requirements.
read / write
validationRegex String
Regular expression which can be used for parameter validation.
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited