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.


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

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

Instance Attribute Details

#allowed_valuesArray<String>

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

Returns:

  • (Array<String>)

208
209
210
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 208

def allowed_values
  @allowed_values
end

#deprecatedBoolean Also known as: deprecated?

If true, it should not be used in new transfers, and it should not be visible to users. Corresponds to the JSON property deprecated

Returns:

  • (Boolean)

214
215
216
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 214

def deprecated
  @deprecated
end

#descriptionString

Parameter description. Corresponds to the JSON property description

Returns:

  • (String)

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

def description
  @description
end

#display_nameString

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

Returns:

  • (String)

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

def display_name
  @display_name
end

#fieldsArray<Google::Apis::BigquerydatatransferV1::DataSourceParameter>

Deprecated. This field has no effect. Corresponds to the JSON property fields


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

def fields
  @fields
end

#immutableBoolean Also known as: immutable?

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

Returns:

  • (Boolean)

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

def immutable
  @immutable
end

#max_valueFloat

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

Returns:

  • (Float)

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

def max_value
  @max_value
end

#min_valueFloat

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

Returns:

  • (Float)

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

def min_value
  @min_value
end

#param_idString

Parameter identifier. Corresponds to the JSON property paramId

Returns:

  • (String)

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

def param_id
  @param_id
end

#recurseBoolean Also known as: recurse?

Deprecated. This field has no effect. Corresponds to the JSON property recurse

Returns:

  • (Boolean)

256
257
258
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 256

def recurse
  @recurse
end

#repeatedBoolean Also known as: repeated?

Deprecated. This field has no effect. Corresponds to the JSON property repeated

Returns:

  • (Boolean)

262
263
264
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 262

def repeated
  @repeated
end

#requiredBoolean Also known as: required?

Is parameter required. Corresponds to the JSON property required

Returns:

  • (Boolean)

268
269
270
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 268

def required
  @required
end

#typeString

Parameter type. Corresponds to the JSON property type

Returns:

  • (String)

274
275
276
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 274

def type
  @type
end

#validation_descriptionString

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)

280
281
282
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 280

def validation_description
  @validation_description
end

#validation_help_urlString

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

Returns:

  • (String)

285
286
287
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 285

def validation_help_url
  @validation_help_url
end

#validation_regexString

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

Returns:

  • (String)

290
291
292
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 290

def validation_regex
  @validation_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'generated/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