class Google::Apis::BigquerydatatransferV1::DataSourceParameter
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
All possible values for the parameter. Corresponds to the JSON property `allowedValues` @return [Array<String>]
If true, it should not be used in new transfers, and it should not be visible to users. Corresponds to the JSON property `deprecated` @return [Boolean]
If true, it should not be used in new transfers, and it should not be visible to users. Corresponds to the JSON property `deprecated` @return [Boolean]
Parameter description. Corresponds to the JSON property `description` @return [String]
Parameter display name in the user interface. Corresponds to the JSON property `displayName` @return [String]
Deprecated. This field has no effect. Corresponds to the JSON property `fields` @return [Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>]
Cannot be changed after initial creation. Corresponds to the JSON property `immutable` @return [Boolean]
Cannot be changed after initial creation. Corresponds to the JSON property `immutable` @return [Boolean]
For integer and double values specifies maxminum allowed value. Corresponds to the JSON property `maxValue` @return [Float]
For integer and double values specifies minimum allowed value. Corresponds to the JSON property `minValue` @return [Float]
Parameter identifier. Corresponds to the JSON property `paramId` @return [String]
Deprecated. This field has no effect. Corresponds to the JSON property `recurse` @return [Boolean]
Deprecated. This field has no effect. Corresponds to the JSON property `recurse` @return [Boolean]
Deprecated. This field has no effect. Corresponds to the JSON property `repeated` @return [Boolean]
Deprecated. This field has no effect. Corresponds to the JSON property `repeated` @return [Boolean]
Is parameter required. Corresponds to the JSON property `required` @return [Boolean]
Is parameter required. Corresponds to the JSON property `required` @return [Boolean]
Parameter type. Corresponds to the JSON property `type` @return [String]
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. Corresponds to the JSON property `validationDescription` @return [String]
URL to a help document to further explain the naming requirements. Corresponds to the JSON property `validationHelpUrl` @return [String]
Regular expression which can be used for parameter validation. Corresponds to the JSON property `validationRegex` @return [String]
Public Class Methods
# File lib/google/apis/bigquerydatatransfer_v1/classes.rb, line 292 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/bigquerydatatransfer_v1/classes.rb, line 297 def update!(**args) @allowed_values = args[:allowed_values] if args.key?(:allowed_values) @deprecated = args[:deprecated] if args.key?(:deprecated) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @fields = args[:fields] if args.key?(:fields) @immutable = args[:immutable] if args.key?(:immutable) @max_value = args[:max_value] if args.key?(:max_value) @min_value = args[:min_value] if args.key?(:min_value) @param_id = args[:param_id] if args.key?(:param_id) @recurse = args[:recurse] if args.key?(:recurse) @repeated = args[:repeated] if args.key?(:repeated) @required = args[:required] if args.key?(:required) @type = args[:type] if args.key?(:type) @validation_description = args[:validation_description] if args.key?(:validation_description) @validation_help_url = args[:validation_help_url] if args.key?(:validation_help_url) @validation_regex = args[:validation_regex] if args.key?(:validation_regex) end