• Home
• com.google.apis
• google-api-services-bigquery
• v2-rev20190423-1.28.0
• source code
• TableFieldSchema.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.bigquery.model.TableFieldSchema.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class TableFieldSchema



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







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









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.



String
getDescription()
[Optional] The field description.



List<TableFieldSchema>
getFields()
[Optional] Describes the nested schema fields if the type property is set to RECORD.



String
getMode()
[Optional] The field mode.



String
getName()
[Required] The field name.



String
getType()
[Required] The field data type.



TableFieldSchema
set(String fieldName,
   Object value) 


TableFieldSchema
setCategories(TableFieldSchema.Categories categories)
[Optional] The categories attached to this field, used for field-level access control.



TableFieldSchema
setDescription(String description)
[Optional] The field description.



TableFieldSchema
setFields(List<TableFieldSchema> fields)
[Optional] Describes the nested schema fields if the type property is set to RECORD.



TableFieldSchema
setMode(String mode)
[Optional] The field mode.



TableFieldSchema
setName(String name)
[Required] The field name.



TableFieldSchema
setType(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 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








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 128
 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 128
 characters.

Parameters:
name - name or null for none








getType
public 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(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(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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2019 Google. All rights reserved.