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

Defined Under Namespace

Classes: Categories, PolicyTags

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TableFieldSchema

Returns a new instance of TableFieldSchema.



6238
6239
6240
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6238

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

Instance Attribute Details

#categories ⇒ Google::Apis::BigqueryV2::TableFieldSchema::Categories

[Optional] The categories attached to this field, used for field-level access control. Corresponds to the JSON property categories

Returns:



6199
6200
6201
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6199

def categories
  @categories
end

#description ⇒ String

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

Returns:

  • (String) 


6204
6205
6206
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6204

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:



6210
6211
6212
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6210

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) 


6216
6217
6218
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6216

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) 


6223
6224
6225
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6223

def name
  @name
end

#policy_tags ⇒ Google::Apis::BigqueryV2::TableFieldSchema::PolicyTags

Corresponds to the JSON property policyTags

Returns:



6228
6229
6230
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6228

def policy_tags
  @policy_tags
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) 


6236
6237
6238
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6236

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6243
6244
6245
6246
6247
6248
6249
6250
6251
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 6243

def update!(**args)
  @categories = args[:categories] if args.key?(:categories)
  @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)
  @policy_tags = args[:policy_tags] if args.key?(:policy_tags)
  @type = args[:type] if args.key?(:type)
end