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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Defined Under Namespace

Classes: Categories, PolicyTags, RangeElementType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TableFieldSchema

Returns a new instance of TableFieldSchema.



8285
8286
8287
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8285

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:



8179
8180
8181
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8179

def categories
  @categories
end

#collation ⇒ String

Optional. Collation specification of the field. It only can be set on string type field. Corresponds to the JSON property collation

Returns:

  • (String) 


8185
8186
8187
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8185

def collation
  @collation
end

#default_value_expression ⇒ String

Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY.

  • Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE( ), DATE '2020-01-01'] Corresponds to the JSON property defaultValueExpression

Returns:

  • (String) 


8197
8198
8199
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8197

def default_value_expression
  @default_value_expression
end

#description ⇒ String

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

Returns:

  • (String) 


8202
8203
8204
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8202

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:



8208
8209
8210
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8208

def fields
  @fields
end

#max_length ⇒ Fixnum

[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". Corresponds to the JSON property maxLength

Returns:

  • (Fixnum) 


8218
8219
8220
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8218

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


8224
8225
8226
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8224

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 300 characters. Corresponds to the JSON property name

Returns:

  • (String) 


8231
8232
8233
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8231

def name
  @name
end

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

Corresponds to the JSON property policyTags

Returns:



8236
8237
8238
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8236

def policy_tags
  @policy_tags
end

#precision ⇒ Fixnum

[Optional] Precision (maximum number of total digits in base 10) and scale ( maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P- S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = " BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid. Corresponds to the JSON property precision

Returns:

  • (Fixnum) 


8256
8257
8258
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8256

def precision
  @precision
end

#range_element_type ⇒ Google::Apis::BigqueryV2::TableFieldSchema::RangeElementType

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP Corresponds to the JSON property rangeElementType

Returns:



8263
8264
8265
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8263

def range_element_type
  @range_element_type
end

#rounding_mode ⇒ String

Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields. Corresponds to the JSON property roundingMode

Returns:

  • (String) 


8269
8270
8271
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8269

def rounding_mode
  @rounding_mode
end

#scale ⇒ Fixnum

[Optional] See documentation for precision. Corresponds to the JSON property scale

Returns:

  • (Fixnum) 


8274
8275
8276
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8274

def scale
  @scale
end

#type ⇒ String

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

Returns:

  • (String) 


8283
8284
8285
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8283

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8290

def update!(**args)
  @categories = args[:categories] if args.key?(:categories)
  @collation = args[:collation] if args.key?(:collation)
  @default_value_expression = args[:default_value_expression] if args.key?(:default_value_expression)
  @description = args[:description] if args.key?(:description)
  @fields = args[:fields] if args.key?(:fields)
  @max_length = args[:max_length] if args.key?(:max_length)
  @mode = args[:mode] if args.key?(:mode)
  @name = args[:name] if args.key?(:name)
  @policy_tags = args[:policy_tags] if args.key?(:policy_tags)
  @precision = args[:precision] if args.key?(:precision)
  @range_element_type = args[:range_element_type] if args.key?(:range_element_type)
  @rounding_mode = args[:rounding_mode] if args.key?(:rounding_mode)
  @scale = args[:scale] if args.key?(:scale)
  @type = args[:type] if args.key?(:type)
end