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

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataSourceParameter

Returns a new instance of DataSourceParameter.



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

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>) 


203
204
205
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 203

def allowed_values
  @allowed_values
end

#deprecated ⇒ Boolean 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) 


209
210
211
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 209

def deprecated
  @deprecated
end

#description ⇒ String

Parameter description. Corresponds to the JSON property description

Returns:

  • (String) 


215
216
217
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 215

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

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

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

Returns:



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

def fields
  @fields
end

#immutable ⇒ Boolean Also known as: immutable?

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

Returns:

  • (Boolean) 


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

def immutable
  @immutable
end

#max_value ⇒ Float

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

Returns:

  • (Float) 


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

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) 


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

def min_value
  @min_value
end

#param_id ⇒ String

Parameter identifier. Corresponds to the JSON property paramId

Returns:

  • (String) 


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

def param_id
  @param_id
end

#recurse ⇒ Boolean Also known as: recurse?

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

Returns:

  • (Boolean) 


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

def recurse
  @recurse
end

#repeated ⇒ Boolean Also known as: repeated?

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

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 257

def repeated
  @repeated
end

#required ⇒ Boolean Also known as: required?

Is parameter required. Corresponds to the JSON property required

Returns:

  • (Boolean) 


263
264
265
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 263

def required
  @required
end

#type ⇒ String

Parameter type. Corresponds to the JSON property type

Returns:

  • (String) 


269
270
271
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 269

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) 


275
276
277
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 275

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) 


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

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) 


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

def validation_regex
  @validation_regex
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 292

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