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.



2767
2768
2769
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2767

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

Instance Attribute Details

#description ⇒ String

[Optional] The field description. The maximum length is 16K characters. Corresponds to the JSON property description

Returns:

  • (String) 


2739
2740
2741
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2739

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:



2745
2746
2747
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2745

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) 


2751
2752
2753
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2751

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) 


2758
2759
2760
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2758

def name
  @name
end

#type ⇒ String

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

Returns:

  • (String) 


2765
2766
2767
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2765

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2772
2773
2774
2775
2776
2777
2778
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2772

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