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

Inherits:

Object

• Object
• Google::Apis::BigqueryV2::TableFieldSchema

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 more...

Instance Attribute Summary

• #description ⇒ String

  [Optional] The field description.

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

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

• #mode ⇒ String

  [Optional] The field mode.

• #name ⇒ String

  [Required] The field name.

• #type ⇒ String

  [Required] The field data type.

Instance Method Summary

• #initialize(**args) ⇒ TableFieldSchema constructor

  A new instance of TableFieldSchema.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3677

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)

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3648

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:

• (Array<Google::Apis::BigqueryV2::TableFieldSchema>)

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3654

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)

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3660

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)

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3667

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)

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3675

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/bigquery_v2/classes.rb', line 3682

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