Struct DataSourceParameter 

#[non_exhaustive]
pub struct DataSourceParameter {

    pub param_id: String,
    pub display_name: String,
    pub description: String,
    pub type: Type,
    pub required: bool,
    pub repeated: bool,
    pub validation_regex: String,
    pub allowed_values: Vec<String>,
    pub min_value: Option<DoubleValue>,
    pub max_value: Option<DoubleValue>,
    pub fields: Vec<DataSourceParameter>,
    pub validation_description: String,
    pub validation_help_url: String,
    pub immutable: bool,
    pub recurse: bool,
    pub deprecated: bool,
    /* private fields */
}

A parameter used to define custom fields in a data source definition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

param_id: String

Parameter identifier.

display_name: String

Parameter display name in the user interface.

description: String

Parameter description.

type: Type

Parameter type.

required: bool

Is parameter required.

repeated: bool

Deprecated. This field has no effect.

validation_regex: String

Regular expression which can be used for parameter validation.

allowed_values: Vec<String>

All possible values for the parameter.

min_value: Option<DoubleValue>

For integer and double values specifies minimum allowed value.

max_value: Option<DoubleValue>

For integer and double values specifies maximum allowed value.

fields: Vec<DataSourceParameter>

Deprecated. This field has no effect.

validation_description: String

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

validation_help_url: String

URL to a help document to further explain the naming requirements.

immutable: bool

Cannot be changed after initial creation.

recurse: bool

Deprecated. This field has no effect.

deprecated: bool

If true, it should not be used in new transfers, and it should not be visible to users.

Implementations

impl DataSourceParameter

pub fn new() -> Self

pub fn set_param_id<T: Into<String>>(self, v: T) -> Self

Sets the value of param_id.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

pub fn set_required<T: Into<bool>>(self, v: T) -> Self

Sets the value of required.

pub fn set_repeated<T: Into<bool>>(self, v: T) -> Self

Sets the value of repeated.

pub fn set_validation_regex<T: Into<String>>(self, v: T) -> Self

Sets the value of validation_regex.

pub fn set_allowed_values<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of allowed_values.

pub fn set_min_value<T>(self, v: T) -> Self

where T: Into<DoubleValue>,

Sets the value of min_value.

pub fn set_or_clear_min_value<T>(self, v: Option<T>) -> Self

where T: Into<DoubleValue>,

Sets or clears the value of min_value.

pub fn set_max_value<T>(self, v: T) -> Self

where T: Into<DoubleValue>,

Sets the value of max_value.

pub fn set_or_clear_max_value<T>(self, v: Option<T>) -> Self

where T: Into<DoubleValue>,

Sets or clears the value of max_value.

pub fn set_fields<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<DataSourceParameter>,

Sets the value of fields.

pub fn set_validation_description<T: Into<String>>(self, v: T) -> Self

Sets the value of validation_description.

pub fn set_validation_help_url<T: Into<String>>(self, v: T) -> Self

Sets the value of validation_help_url.

pub fn set_immutable<T: Into<bool>>(self, v: T) -> Self

Sets the value of immutable.

pub fn set_recurse<T: Into<bool>>(self, v: T) -> Self

Sets the value of recurse.

pub fn set_deprecated<T: Into<bool>>(self, v: T) -> Self

Sets the value of deprecated.

Trait Implementations

impl Clone for DataSourceParameter

fn clone(&self) -> DataSourceParameter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataSourceParameter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DataSourceParameter

fn default() -> DataSourceParameter

Returns the “default value” for a type.

impl Message for DataSourceParameter

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DataSourceParameter

fn eq(&self, other: &DataSourceParameter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DataSourceParameter