Class: Google::Apis::BigqueryV2::TableFieldSchema

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

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

Returns a new instance of TableFieldSchema



3261
3262
3263
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3261

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

Instance Attribute Details

#descriptionString

[Optional] The field description. The maximum length is 1,024 characters. Corresponds to the JSON property description

Returns:

  • (String)


3232
3233
3234
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3232

def description
  @description
end

#fieldsArray<Google::Apis::BigqueryV2::TableFieldSchema>

[Optional] Describes the nested schema fields if the type property is set to RECORD. Corresponds to the JSON property fields



3238
3239
3240
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3238

def fields
  @fields
end

#modeString

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. Corresponds to the JSON property mode

Returns:

  • (String)


3244
3245
3246
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3244

def mode
  @mode
end

#nameString

[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters. Corresponds to the JSON property name

Returns:

  • (String)


3251
3252
3253
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3251

def name
  @name
end

#typeString

[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). Corresponds to the JSON property type

Returns:

  • (String)


3259
3260
3261
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3259

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3266
3267
3268
3269
3270
3271
3272
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3266

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @fields = args[:fields] if args.key?(:fields)
  @mode = args[:mode] if args.key?(:mode)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end