Class DataSourceParameter (2.1.2)

DataSourceParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

Attributes

NameDescription
param_id str
Parameter identifier.
display_name str
Parameter display name in the user interface.
description str
Parameter description.
type .datatransfer.DataSourceParameter.Type
Parameter type.
required bool
Is parameter required.
repeated bool
Deprecated. This field has no effect.
validation_regex str
Regular expression which can be used for parameter validation.
allowed_values Sequence[str]
All possible values for the parameter.
min_value .wrappers.DoubleValue
For integer and double values specifies minimum allowed value.
max_value .wrappers.DoubleValue
For integer and double values specifies maxminum allowed value.
fields Sequence[.datatransfer.DataSourceParameter]
Deprecated. This field has no effect.
validation_description str
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 str
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.

Classes

Type

Type(value)

Parameter type.