Class: Google::Apis::BigquerydatatransferV1::DataSourceParameter

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigquerydatatransfer_v1/classes.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DataSourceParameter

Returns a new instance of DataSourceParameter



294
295
296
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 294

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allowed_values ⇒ Array<String>

All possible values for the parameter. Corresponds to the JSON property allowedValues

Returns:

  • (Array<String>) 


216
217
218
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 216

def allowed_values
  @allowed_values
end

#description ⇒ String

Parameter description. Corresponds to the JSON property description

Returns:

  • (String) 


221
222
223
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 221

def description
  @description
end

#display_name ⇒ String

Parameter display name in the user interface. Corresponds to the JSON property displayName

Returns:

  • (String) 


226
227
228
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 226

def display_name
  @display_name
end

#fields ⇒ Array<Google::Apis::BigquerydatatransferV1::DataSourceParameter>

When parameter is a record, describes child fields. Corresponds to the JSON property fields

Returns:



231
232
233
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 231

def fields
  @fields
end

#immutable ⇒ Boolean Also known as: immutable?

Cannot be changed after initial creation. Corresponds to the JSON property immutable

Returns:

  • (Boolean) 


236
237
238
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 236

def immutable
  @immutable
end

#max_value ⇒ Float

For integer and double values specifies maxminum allowed value. Corresponds to the JSON property maxValue

Returns:

  • (Float) 


242
243
244
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 242

def max_value
  @max_value
end

#min_value ⇒ Float

For integer and double values specifies minimum allowed value. Corresponds to the JSON property minValue

Returns:

  • (Float) 


247
248
249
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 247

def min_value
  @min_value
end

#param_id ⇒ String

Parameter identifier. Corresponds to the JSON property paramId

Returns:

  • (String) 


252
253
254
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 252

def param_id
  @param_id
end

#recurse ⇒ Boolean Also known as: recurse?

If set to true, schema should be taken from the parent with the same parameter_id. Only applicable when parameter type is RECORD. Corresponds to the JSON property recurse

Returns:

  • (Boolean) 


258
259
260
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 258

def recurse
  @recurse
end

#repeated ⇒ Boolean Also known as: repeated?

Can parameter have multiple values. Corresponds to the JSON property repeated

Returns:

  • (Boolean) 


264
265
266
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 264

def repeated
  @repeated
end

#required ⇒ Boolean Also known as: required?

Is parameter required. Corresponds to the JSON property required

Returns:

  • (Boolean) 


270
271
272
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 270

def required
  @required
end

#type ⇒ String

Parameter type. Corresponds to the JSON property type

Returns:

  • (String) 


276
277
278
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 276

def type
  @type
end

#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. Corresponds to the JSON property validationDescription

Returns:

  • (String) 


282
283
284
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 282

def validation_description
  @validation_description
end

#validation_help_url ⇒ String

URL to a help document to further explain the naming requirements. Corresponds to the JSON property validationHelpUrl

Returns:

  • (String) 


287
288
289
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 287

def validation_help_url
  @validation_help_url
end

#validation_regex ⇒ String

Regular expression which can be used for parameter validation. Corresponds to the JSON property validationRegex

Returns:

  • (String) 


292
293
294
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 292

def validation_regex
  @validation_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 299

def update!(**args)
  @allowed_values = args[:allowed_values] if args.key?(:allowed_values)
  @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