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

Overview

A field in TableSchema

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.



9886
9887
9888
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9886

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

Instance Attribute Details

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

Deprecated. Corresponds to the JSON property categories

Returns:



9786
9787
9788
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9786

def categories
  @categories
end

#collation ⇒ String

Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. Corresponds to the JSON property collation

Returns:

  • (String) 


9793
9794
9795
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9793

def collation
  @collation
end

#default_value_expression ⇒ String

Optional. A SQL expression to specify the default value for this field. Corresponds to the JSON property defaultValueExpression

Returns:

  • (String) 


9799
9800
9801
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9799

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) 


9804
9805
9806
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9804

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:



9810
9811
9812
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9810

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) 


9820
9821
9822
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9820

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) 


9826
9827
9828
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9826

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) 


9833
9834
9835
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9833

def name
  @name
end

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

Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags. Corresponds to the JSON property policyTags

Returns:



9839
9840
9841
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9839

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) 


9859
9860
9861
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9859

def precision
  @precision
end

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

Represents the type of a field element. Corresponds to the JSON property rangeElementType

Returns:



9864
9865
9866
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9864

def range_element_type
  @range_element_type
end

#rounding_mode ⇒ String

Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type. Corresponds to the JSON property roundingMode

Returns:

  • (String) 


9870
9871
9872
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9870

def rounding_mode
  @rounding_mode
end

#scale ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9875
9876
9877
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9875

def scale
  @scale
end

#type ⇒ String

Required. The field data type. Possible values include: * STRING * BYTES * INTEGER (or INT64) * FLOAT (or FLOAT64) * BOOLEAN (or BOOL) * TIMESTAMP * DATE

  • TIME * DATETIME * GEOGRAPHY * NUMERIC * BIGNUMERIC * JSON * RECORD (or STRUCT) * RANGE (Preview) Use of RECORD/ STRUCT indicates that the field contains a nested schema. Corresponds to the JSON property type

Returns:

  • (String) 


9884
9885
9886
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9884

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9891

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