TableFieldSchema (BigQuery API v2-rev20251012-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.bigquery.model.TableFieldSchema

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class TableFieldSchema
extends com.google.api.client.json.GenericJson
```
A field in TableSchema
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TableFieldSchema.Categories` Deprecated.
`static class`	`TableFieldSchema.PolicyTags` Optional.
`static class`	`TableFieldSchema.RangeElementType` Represents the type of a field element.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

TableFieldSchema()

Constructors
Constructor and Description
`TableFieldSchema()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableFieldSchema`	`clone()`
`TableFieldSchema.Categories`	`getCategories()` Deprecated.
`String`	`getCollation()` Optional.
`List<DataPolicyOption>`	`getDataPolicies()` Optional.
`String`	`getDefaultValueExpression()` Optional.
`String`	`getDescription()` Optional.
`List<TableFieldSchema>`	`getFields()` Optional.
`String`	`getForeignTypeDefinition()` Optional.
`Long`	`getMaxLength()` Optional.
`String`	`getMode()` Optional.
`String`	`getName()` Required.
`TableFieldSchema.PolicyTags`	`getPolicyTags()` Optional.
`Long`	`getPrecision()` Optional.
`TableFieldSchema.RangeElementType`	`getRangeElementType()` Represents the type of a field element.
`String`	`getRoundingMode()` Optional.
`Long`	`getScale()` Optional.
`Long`	`getTimestampPrecision()` Optional.
`String`	`getType()` Required.
`TableFieldSchema`	`set(String fieldName, Object value)`
`TableFieldSchema`	`setCategories(TableFieldSchema.Categories categories)` Deprecated.
`TableFieldSchema`	`setCollation(String collation)` Optional.
`TableFieldSchema`	`setDataPolicies(List<DataPolicyOption> dataPolicies)` Optional.
`TableFieldSchema`	`setDefaultValueExpression(String defaultValueExpression)` Optional.
`TableFieldSchema`	`setDescription(String description)` Optional.
`TableFieldSchema`	`setFields(List<TableFieldSchema> fields)` Optional.
`TableFieldSchema`	`setForeignTypeDefinition(String foreignTypeDefinition)` Optional.
`TableFieldSchema`	`setMaxLength(Long maxLength)` Optional.
`TableFieldSchema`	`setMode(String mode)` Optional.
`TableFieldSchema`	`setName(String name)` Required.
`TableFieldSchema`	`setPolicyTags(TableFieldSchema.PolicyTags policyTags)` Optional.
`TableFieldSchema`	`setPrecision(Long precision)` Optional.
`TableFieldSchema`	`setRangeElementType(TableFieldSchema.RangeElementType rangeElementType)` Represents the type of a field element.
`TableFieldSchema`	`setRoundingMode(String roundingMode)` Optional.
`TableFieldSchema`	`setScale(Long scale)` Optional.
`TableFieldSchema`	`setTimestampPrecision(Long timestampPrecision)` Optional.
`TableFieldSchema`	`setType(String type)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - TableFieldSchema
```
public TableFieldSchema()
```
- Method Detail
  - getCategories
```
public TableFieldSchema.Categories getCategories()
```
    Deprecated.
    
    Returns:
    
    value or null for none
  - setCategories
```
public TableFieldSchema setCategories(TableFieldSchema.Categories categories)
```
    Deprecated.
    
    Parameters:
    
    categories - categories or null for none
  - getCollation
```
public String getCollation()
```
    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.
    
    Returns:
    
    value or null for none
  - setCollation
```
public TableFieldSchema setCollation(String collation)
```
    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.
    
    Parameters:
    
    collation - collation or null for none
  - getDataPolicies
```
public List<DataPolicyOption> getDataPolicies()
```
    Optional. Data policies attached to this field, used for field-level access control.
    
    Returns:
    
    value or null for none
  - setDataPolicies
```
public TableFieldSchema setDataPolicies(List<DataPolicyOption> dataPolicies)
```
    Optional. Data policies attached to this field, used for field-level access control.
    
    Parameters:
    
    dataPolicies - dataPolicies or null for none
  - getDefaultValueExpression
```
public String getDefaultValueExpression()
```
    Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
    
    Returns:
    
    value or null for none
  - setDefaultValueExpression
```
public TableFieldSchema setDefaultValueExpression(String defaultValueExpression)
```
    Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.
    
    Parameters:
    
    defaultValueExpression - defaultValueExpression or null for none
  - getDescription
```
public String getDescription()
```
    Optional. The field description. The maximum length is 1,024 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public TableFieldSchema setDescription(String description)
```
    Optional. The field description. The maximum length is 1,024 characters.
    
    Parameters:
    
    description - description or null for none
  - getFields
```
public List<TableFieldSchema> getFields()
```
    Optional. Describes the nested schema fields if the type property is set to RECORD.
    
    Returns:
    
    value or null for none
  - setFields
```
public TableFieldSchema setFields(List<TableFieldSchema> fields)
```
    Optional. Describes the nested schema fields if the type property is set to RECORD.
    
    Parameters:
    
    fields - fields or null for none
  - getForeignTypeDefinition
```
public String getForeignTypeDefinition()
```
    Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.
    
    Returns:
    
    value or null for none
  - setForeignTypeDefinition
```
public TableFieldSchema setForeignTypeDefinition(String foreignTypeDefinition)
```
    Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.
    
    Parameters:
    
    foreignTypeDefinition - foreignTypeDefinition or null for none
  - getMaxLength
```
public Long getMaxLength()
```
    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".
    
    Returns:
    
    value or null for none
  - setMaxLength
```
public TableFieldSchema setMaxLength(Long 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".
    
    Parameters:
    
    maxLength - maxLength or null for none
  - getMode
```
public String getMode()
```
    Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
    
    Returns:
    
    value or null for none
  - setMode
```
public TableFieldSchema setMode(String mode)
```
    Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
    
    Parameters:
    
    mode - mode or null for none
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    value or null for none
  - setName
```
public TableFieldSchema setName(String 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.
    
    Parameters:
    
    name - name or null for none
  - getPolicyTags
```
public TableFieldSchema.PolicyTags getPolicyTags()
```
    Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
    
    Returns:
    
    value or null for none
  - setPolicyTags
```
public TableFieldSchema setPolicyTags(TableFieldSchema.PolicyTags policyTags)
```
    Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.
    
    Parameters:
    
    policyTags - policyTags or null for none
  - getPrecision
```
public Long getPrecision()
```
    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.
    
    Returns:
    
    value or null for none
  - setPrecision
```
public TableFieldSchema setPrecision(Long 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.
    
    Parameters:
    
    precision - precision or null for none
  - getRangeElementType
```
public TableFieldSchema.RangeElementType getRangeElementType()
```
    Represents the type of a field element.
    
    Returns:
    
    value or null for none
  - setRangeElementType
```
public TableFieldSchema setRangeElementType(TableFieldSchema.RangeElementType rangeElementType)
```
    Represents the type of a field element.
    
    Parameters:
    
    rangeElementType - rangeElementType or null for none
  - getRoundingMode
```
public String getRoundingMode()
```
    Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
    
    Returns:
    
    value or null for none
  - setRoundingMode
```
public TableFieldSchema setRoundingMode(String roundingMode)
```
    Optional. Specifies the rounding mode to be used when storing values of NUMERIC and BIGNUMERIC type.
    
    Parameters:
    
    roundingMode - roundingMode or null for none
  - getScale
```
public Long getScale()
```
    Optional. See documentation for precision.
    
    Returns:
    
    value or null for none
  - setScale
```
public TableFieldSchema setScale(Long scale)
```
    Optional. See documentation for precision.
    
    Parameters:
    
    scale - scale or null for none
  - getTimestampPrecision
```
public Long getTimestampPrecision()
```
    Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)
    
    Returns:
    
    value or null for none
  - setTimestampPrecision
```
public TableFieldSchema setTimestampPrecision(Long timestampPrecision)
```
    Optional. Precision (maximum number of total digits in base 10) for seconds of TIMESTAMP type. Possible values include: * 6 (Default, for TIMESTAMP type with microsecond precision) * 12 (For TIMESTAMP type with picosecond precision)
    
    Parameters:
    
    timestampPrecision - timestampPrecision or null for none
  - getType
```
public String getType()
```
    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 Use of RECORD/STRUCT indicates that the field contains a nested schema.
    
    Returns:
    
    value or null for none
  - setType
```
public TableFieldSchema setType(String type)
```
    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 Use of RECORD/STRUCT indicates that the field contains a nested schema.
    
    Parameters:
    
    type - type or null for none
  - set
```
public TableFieldSchema set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TableFieldSchema clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class TableFieldSchema

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

TableFieldSchema

Method Detail

getCategories

setCategories

getCollation

setCollation

getDataPolicies

setDataPolicies

getDefaultValueExpression

setDefaultValueExpression

getDescription

setDescription

getFields

setFields

getForeignTypeDefinition

setForeignTypeDefinition

getMaxLength

setMaxLength

getMode

setMode

getName

setName

getPolicyTags

setPolicyTags

getPrecision

setPrecision

getRangeElementType

setRangeElementType

getRoundingMode

setRoundingMode

getScale

setScale

getTimestampPrecision

setTimestampPrecision

getType

setType

set

clone