TableFieldSchemaArgs

data class TableFieldSchemaArgs(val categories: Output<TableFieldSchemaCategoriesArgs>? = null, val collation: Output<String>? = null, val defaultValueExpression: Output<String>? = null, val description: Output<String>? = null, val fields: Output<List<TableFieldSchemaArgs>>? = null, val maxLength: Output<String>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val policyTags: Output<TableFieldSchemaPolicyTagsArgs>? = null, val precision: Output<String>? = null, val roundingMode: Output<String>? = null, val scale: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<TableFieldSchemaArgs>

Constructors

Link copied to clipboard
fun TableFieldSchemaArgs(categories: Output<TableFieldSchemaCategoriesArgs>? = null, collation: Output<String>? = null, defaultValueExpression: Output<String>? = null, description: Output<String>? = null, fields: Output<List<TableFieldSchemaArgs>>? = null, maxLength: Output<String>? = null, mode: Output<String>? = null, name: Output<String>? = null, policyTags: Output<TableFieldSchemaPolicyTagsArgs>? = null, precision: Output<String>? = null, roundingMode: Output<String>? = null, scale: Output<String>? = null, type: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): TableFieldSchemaArgs

Properties

Link copied to clipboard

Optional The categories attached to this field, used for field-level access control.

Link copied to clipboard
val collation: Output<String>? = null

Optional. Collation specification of the field. It only can be set on string type field.

Link copied to clipboard
val defaultValueExpression: Output<String>? = null

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'

Link copied to clipboard
val description: Output<String>? = null

Optional The field description. The maximum length is 1,024 characters.

Link copied to clipboard
val fields: Output<List<TableFieldSchemaArgs>>? = null

Optional Describes the nested schema fields if the type property is set to RECORD.

Link copied to clipboard
val maxLength: Output<String>? = null

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".

Link copied to clipboard
val mode: Output<String>? = null

Optional The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
Link copied to clipboard
val precision: Output<String>? = null

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.

Link copied to clipboard
val roundingMode: Output<String>? = null

Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.

Link copied to clipboard
val scale: Output<String>? = null

Optional See documentation for precision.

Link copied to clipboard
val type: Output<String>? = null

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).