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



2808
2809
2810
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2808

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

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


2779
2780
2781
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2779

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



2785
2786
2787
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2785

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)


2791
2792
2793
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2791

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)


2798
2799
2800
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2798

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)


2806
2807
2808
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2806

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2813
2814
2815
2816
2817
2818
2819
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2813

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