TableFieldSchemaResponse class
Constructors
-
TableFieldSchemaResponse({required Input<TableFieldSchemaCategoriesResponse> categories, required Input<String> collation, required Input<String> defaultValueExpression, required Input<String> description, required Input<List<TableFieldSchemaResponse>> fields, required Input<String> maxLength, required Input<String> mode, required Input<String> name, required Input<TableFieldSchemaPolicyTagsResponse> policyTags, required Input<String> precision, required Input<TableFieldSchemaRangeElementTypeResponse> rangeElementType, required Input<String> roundingMode, required Input<String> scale, required Input<String> type})
-
Creates a new TableFieldSchemaResponse.
categories
Optional The categories attached to this field, used for field-level access control.
collation Optional. Collation specification of the field. It only can be set on string type field.
defaultValueExpression 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'
description Optional The field description. The maximum length is 1,024 characters.
fields Optional Describes the nested schema fields if the type property is set to RECORD.
maxLength 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".
mode Optional The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name 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.
policyTags Required.
precision 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.
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
roundingMode Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
scale Optional See documentation for precision.
type 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).
const
-
TableFieldSchemaResponse.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
categories
→ Input<TableFieldSchemaCategoriesResponse>
-
Optional The categories attached to this field, used for field-level access control.
final
-
collation
→ Input<String>
-
Optional. Collation specification of the field. It only can be set on string type field.
final
-
defaultValueExpression
→ Input<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'
final
-
description
→ Input<String>
-
Optional The field description. The maximum length is 1,024 characters.
final
-
fields
→ Input<List<TableFieldSchemaResponse>>
-
Optional Describes the nested schema fields if the type property is set to RECORD.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
maxLength
→ Input<String>
-
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".
final
-
mode
→ Input<String>
-
Optional The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
final
-
name
→ Input<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.
final
-
policyTags
→ Input<TableFieldSchemaPolicyTagsResponse>
-
final
-
precision
→ Input<String>
-
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.
final
-
rangeElementType
→ Input<TableFieldSchemaRangeElementTypeResponse>
-
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
final
-
roundingMode
→ Input<String>
-
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
scale
→ Input<String>
-
Optional See documentation for precision.
final
-
type
→ Input<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).
final
