BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::TableFieldSchema (v0.12.0)

Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::TableFieldSchema.

TableFieldSchema defines a single field/column within a table schema.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. The field description. The maximum length is 1,024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The field description. The maximum length is 1,024 characters.
Returns
  • (::String) — Optional. The field description. The maximum length is 1,024 characters.

#fields

def fields() -> ::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>
Returns

#fields=

def fields=(value) -> ::Array<::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema>
Parameter
Returns

#max_length

def max_length() -> ::Integer
Returns
  • (::Integer) — 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 is not "STRING" or "BYTES".

#max_length=

def max_length=(value) -> ::Integer
Parameter
  • value (::Integer) — 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 is not "STRING" or "BYTES".

Returns
  • (::Integer) — 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 is not "STRING" or "BYTES".

#mode

def mode() -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode
Returns

#mode=

def mode=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Mode
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#precision

def precision() -> ::Integer
Returns
  • (::Integer) — 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 is not "NUMERIC" or "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: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
    • Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 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.

#precision=

def precision=(value) -> ::Integer
Parameter
  • value (::Integer) — 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 is not "NUMERIC" or "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: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
    • Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 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.

Returns
  • (::Integer) — 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 is not "NUMERIC" or "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: [-10^(P-S) + 10^(-S), 10^(P-S) - 10^(-S)]
    • Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10^P + 1, 10^P - 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.

#scale

def scale() -> ::Integer
Returns
  • (::Integer) — Optional. See documentation for precision.

#scale=

def scale=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. See documentation for precision.
Returns
  • (::Integer) — Optional. See documentation for precision.

#type

def type() -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableFieldSchema::Type
Parameter
Returns