• Home
• com.google.apis
• google-api-services-bigquery
• v2-rev20220422-1.32.1
• 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 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
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
getCollation()
Optional.



String
getDefaultValueExpression()
Optional.



String
getDescription()
[Optional] The field description.



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



Long
getMaxLength()
[Optional] Maximum length of values of this field for STRINGS or BYTES.



String
getMode()
[Optional] The field mode.



String
getName()
[Required] The field name.



TableFieldSchema.PolicyTags
getPolicyTags() 


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.



Long
getScale()
[Optional] See documentation for precision.



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
setCollation(String collation)
Optional.



TableFieldSchema
setDefaultValueExpression(String defaultValueExpression)
Optional.



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
setMaxLength(Long maxLength)
[Optional] Maximum length of values of this field for STRINGS or BYTES.



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



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



TableFieldSchema
setPolicyTags(TableFieldSchema.PolicyTags policyTags) 


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.



TableFieldSchema
setScale(Long scale)
[Optional] See documentation for precision.



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








getCollation
public String getCollation()
Optional. Collation specification of the field. It only can be set on string type field.

Returns:
value or null for none








setCollation
public TableFieldSchema setCollation(String collation)
Optional. Collation specification of the field. It only can be set on string type field.

Parameters:
collation - collation or null for none








getDefaultValueExpression
public String getDefaultValueExpression()
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']

Returns:
value or null for none








setDefaultValueExpression
public TableFieldSchema setDefaultValueExpression(String 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']

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








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

Returns:
value or null for none








setPolicyTags
public TableFieldSchema setPolicyTags(TableFieldSchema.PolicyTags policyTags)

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








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








getType
public String getType()
[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).

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

Parameters:
type - type or null for none








set
public TableFieldSchema set(String fieldName,
                            Object value)

Overrides:
set in class GenericJson








clone
public TableFieldSchema clone()

Overrides:
clone in class 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–2022 Google. All rights reserved.