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



3460
3461
3462
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3460

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


3431
3432
3433
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3431

def description
  @description
end

#fields ⇒ Array<Google::Apis::BigqueryV2::TableFieldSchema>

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

Returns:



3437
3438
3439
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3437

def fields
  @fields
end

#mode ⇒ String

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

Returns:

  • (String) 


3443
3444
3445
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3443

def mode
  @mode
end

#name ⇒ String

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


3450
3451
3452
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3450

def name
  @name
end

#type ⇒ String

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


3458
3459
3460
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3458

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3465
3466
3467
3468
3469
3470
3471
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3465

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