TableFieldSchema (BigQuery API v2 (Rev. 459) 1.25.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class TableFieldSchema
extends com.google.api.client.json.GenericJson
```
Model definition for TableFieldSchema.
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` [Optional] The categories attached to this field, used for field-level access control.
`static class`	`TableFieldSchema.PolicyTags` Model definition for TableFieldSchemaPolicyTags.

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
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
java.util.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()` [Optional] The categories attached to this field, used for field-level access control.
`java.lang.String`	`getDescription()` [Optional] The field description.
`java.util.List<TableFieldSchema>`	`getFields()` [Optional] Describes the nested schema fields if the type property is set to RECORD.
`java.lang.String`	`getMode()` [Optional] The field mode.
`java.lang.String`	`getName()` [Required] The field name.
`TableFieldSchema.PolicyTags`	`getPolicyTags()`
`java.lang.String`	`getType()` [Required] The field data type.
`TableFieldSchema`	`set(java.lang.String fieldName, java.lang.Object value)`
`TableFieldSchema`	`setCategories(TableFieldSchema.Categories categories)` [Optional] The categories attached to this field, used for field-level access control.
`TableFieldSchema`	`setDescription(java.lang.String description)` [Optional] The field description.
`TableFieldSchema`	`setFields(java.util.List<TableFieldSchema> fields)` [Optional] Describes the nested schema fields if the type property is set to RECORD.
`TableFieldSchema`	`setMode(java.lang.String mode)` [Optional] The field mode.
`TableFieldSchema`	`setName(java.lang.String name)` [Required] The field name.
`TableFieldSchema`	`setPolicyTags(TableFieldSchema.PolicyTags policyTags)`
`TableFieldSchema`	`setType(java.lang.String type)` [Required] The field data type.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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()
```
    [Optional] The categories attached to this field, used for field-level access control.
    
    Returns:
    
    value or null for none
  - setCategories
```
public TableFieldSchema setCategories(TableFieldSchema.Categories categories)
```
    [Optional] The categories attached to this field, used for field-level access control.
    
    Parameters:
    
    categories - categories or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    [Optional] The field description. The maximum length is 1,024 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public TableFieldSchema setDescription(java.lang.String description)
```
    [Optional] The field description. The maximum length is 1,024 characters.
    
    Parameters:
    
    description - description or null for none
  - getFields
```
public java.util.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(java.util.List<TableFieldSchema> fields)
```
    [Optional] Describes the nested schema fields if the type property is set to RECORD.
    
    Parameters:
    
    fields - fields or null for none
  - getMode
```
public java.lang.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(java.lang.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 java.lang.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 128 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public TableFieldSchema setName(java.lang.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 128 characters.
    
    Parameters:
    
    name - name or null for none
  - getPolicyTags
```
public TableFieldSchema.PolicyTags getPolicyTags()
```
    Returns:
    
    value or null for none
  - setPolicyTags
```
public TableFieldSchema setPolicyTags(TableFieldSchema.PolicyTags policyTags)
```
    Parameters:
    
    policyTags - policyTags or null for none
  - getType
```
public java.lang.String getType()
```
    [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
    
    Returns:
    
    value or null for none
  - setType
```
public TableFieldSchema setType(java.lang.String type)
```
    [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
    
    Parameters:
    
    type - type or null for none
  - set
```
public TableFieldSchema set(java.lang.String fieldName,
                            java.lang.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

BigQuery API v2 (revision 459)

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

getDescription

setDescription

getFields

setFields

getMode

setMode

getName

setName

getPolicyTags

setPolicyTags

getType

setType

set

clone