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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation

There is a newer version: v2-rev20241222-2.0.0

Show newest version







ExternalDataConfiguration (BigQuery API v2-rev20190423-1.28.0)











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 ExternalDataConfiguration



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class ExternalDataConfiguration
extends com.google.api.client.json.GenericJson
Model definition for ExternalDataConfiguration.

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


ExternalDataConfiguration() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ExternalDataConfiguration
clone() 


Boolean
getAutodetect()
Try to detect schema and format options automatically.



BigtableOptions
getBigtableOptions()
[Optional] Additional options if sourceFormat is set to BIGTABLE.



String
getCompression()
[Optional] The compression type of the data source.



CsvOptions
getCsvOptions()
Additional properties to set if sourceFormat is set to CSV.



GoogleSheetsOptions
getGoogleSheetsOptions()
[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.



String
getHivePartitioningMode()
[Optional, Experimental] If hive partitioning is enabled, which mode to use.



Boolean
getIgnoreUnknownValues()
[Optional] Indicates if BigQuery should allow extra values that are not represented in the
 table schema.



Integer
getMaxBadRecords()
[Optional] The maximum number of bad records that BigQuery can ignore when reading data.



TableSchema
getSchema()
[Optional] The schema for the data.



String
getSourceFormat()
[Required] The data format.



List<String>
getSourceUris()
[Required] The fully-qualified URIs that point to your data in Google Cloud.



ExternalDataConfiguration
set(String fieldName,
   Object value) 


ExternalDataConfiguration
setAutodetect(Boolean autodetect)
Try to detect schema and format options automatically.



ExternalDataConfiguration
setBigtableOptions(BigtableOptions bigtableOptions)
[Optional] Additional options if sourceFormat is set to BIGTABLE.



ExternalDataConfiguration
setCompression(String compression)
[Optional] The compression type of the data source.



ExternalDataConfiguration
setCsvOptions(CsvOptions csvOptions)
Additional properties to set if sourceFormat is set to CSV.



ExternalDataConfiguration
setGoogleSheetsOptions(GoogleSheetsOptions googleSheetsOptions)
[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.



ExternalDataConfiguration
setHivePartitioningMode(String hivePartitioningMode)
[Optional, Experimental] If hive partitioning is enabled, which mode to use.



ExternalDataConfiguration
setIgnoreUnknownValues(Boolean ignoreUnknownValues)
[Optional] Indicates if BigQuery should allow extra values that are not represented in the
 table schema.



ExternalDataConfiguration
setMaxBadRecords(Integer maxBadRecords)
[Optional] The maximum number of bad records that BigQuery can ignore when reading data.



ExternalDataConfiguration
setSchema(TableSchema schema)
[Optional] The schema for the data.



ExternalDataConfiguration
setSourceFormat(String sourceFormat)
[Required] The data format.



ExternalDataConfiguration
setSourceUris(List<String> sourceUris)
[Required] The fully-qualified URIs that point to your data in Google Cloud.







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





ExternalDataConfiguration
public ExternalDataConfiguration()









Method Detail





getAutodetect
public Boolean getAutodetect()
Try to detect schema and format options automatically. Any option specified explicitly will be
 honored.

Returns:
value or null for none








setAutodetect
public ExternalDataConfiguration setAutodetect(Boolean autodetect)
Try to detect schema and format options automatically. Any option specified explicitly will be
 honored.

Parameters:
autodetect - autodetect or null for none








getBigtableOptions
public BigtableOptions getBigtableOptions()
[Optional] Additional options if sourceFormat is set to BIGTABLE.

Returns:
value or null for none








setBigtableOptions
public ExternalDataConfiguration setBigtableOptions(BigtableOptions bigtableOptions)
[Optional] Additional options if sourceFormat is set to BIGTABLE.

Parameters:
bigtableOptions - bigtableOptions or null for none








getCompression
public String getCompression()
[Optional] The compression type of the data source. Possible values include GZIP and NONE. The
 default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud
 Datastore backups and Avro formats.

Returns:
value or null for none








setCompression
public ExternalDataConfiguration setCompression(String compression)
[Optional] The compression type of the data source. Possible values include GZIP and NONE. The
 default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud
 Datastore backups and Avro formats.

Parameters:
compression - compression or null for none








getCsvOptions
public CsvOptions getCsvOptions()
Additional properties to set if sourceFormat is set to CSV.

Returns:
value or null for none








setCsvOptions
public ExternalDataConfiguration setCsvOptions(CsvOptions csvOptions)
Additional properties to set if sourceFormat is set to CSV.

Parameters:
csvOptions - csvOptions or null for none








getGoogleSheetsOptions
public GoogleSheetsOptions getGoogleSheetsOptions()
[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

Returns:
value or null for none








setGoogleSheetsOptions
public ExternalDataConfiguration setGoogleSheetsOptions(GoogleSheetsOptions googleSheetsOptions)
[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

Parameters:
googleSheetsOptions - googleSheetsOptions or null for none








getHivePartitioningMode
public String getHivePartitioningMode()
[Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are
 supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic
 infer partition key name(s). All types are strings. Not all storage formats support hive
 partitioning -- requesting hive partitioning on an unsupported format will lead to an error.

Returns:
value or null for none








setHivePartitioningMode
public ExternalDataConfiguration setHivePartitioningMode(String hivePartitioningMode)
[Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are
 supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic
 infer partition key name(s). All types are strings. Not all storage formats support hive
 partitioning -- requesting hive partitioning on an unsupported format will lead to an error.

Parameters:
hivePartitioningMode - hivePartitioningMode or null for none








getIgnoreUnknownValues
public Boolean getIgnoreUnknownValues()
[Optional] Indicates if BigQuery should allow extra values that are not represented in the
 table schema. If true, the extra values are ignored. If false, records with extra columns are
 treated as bad records, and if there are too many bad records, an invalid error is returned in
 the job result. The default value is false. The sourceFormat property determines what BigQuery
 treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column
 names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This
 setting is ignored. Avro: This setting is ignored.

Returns:
value or null for none








setIgnoreUnknownValues
public ExternalDataConfiguration setIgnoreUnknownValues(Boolean ignoreUnknownValues)
[Optional] Indicates if BigQuery should allow extra values that are not represented in the
 table schema. If true, the extra values are ignored. If false, records with extra columns are
 treated as bad records, and if there are too many bad records, an invalid error is returned in
 the job result. The default value is false. The sourceFormat property determines what BigQuery
 treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column
 names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This
 setting is ignored. Avro: This setting is ignored.

Parameters:
ignoreUnknownValues - ignoreUnknownValues or null for none








getMaxBadRecords
public Integer getMaxBadRecords()
[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the
 number of bad records exceeds this value, an invalid error is returned in the job result. This
 is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all
 records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore
 backups and Avro formats.

Returns:
value or null for none








setMaxBadRecords
public ExternalDataConfiguration setMaxBadRecords(Integer maxBadRecords)
[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the
 number of bad records exceeds this value, an invalid error is returned in the job result. This
 is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all
 records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore
 backups and Avro formats.

Parameters:
maxBadRecords - maxBadRecords or null for none








getSchema
public TableSchema getSchema()
[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is
 disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

Returns:
value or null for none








setSchema
public ExternalDataConfiguration setSchema(TableSchema schema)
[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is
 disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.

Parameters:
schema - schema or null for none








getSourceFormat
public String getSourceFormat()
[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify
 "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files,
 specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For
 Google Cloud Bigtable, specify "BIGTABLE".

Returns:
value or null for none








setSourceFormat
public ExternalDataConfiguration setSourceFormat(String sourceFormat)
[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify
 "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files,
 specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For
 Google Cloud Bigtable, specify "BIGTABLE".

Parameters:
sourceFormat - sourceFormat or null for none








getSourceUris
public List<String> getSourceUris()
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud
 Storage URIs: Each URI can contain one '*' wildcard character and it must come after the
 'bucket' name. Size limits related to load jobs apply to external data sources. For Google
 Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid
 HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one
 URI can be specified. Also, the '*' wildcard character is not allowed.

Returns:
value or null for none








setSourceUris
public ExternalDataConfiguration setSourceUris(List<String> sourceUris)
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud
 Storage URIs: Each URI can contain one '*' wildcard character and it must come after the
 'bucket' name. Size limits related to load jobs apply to external data sources. For Google
 Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid
 HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one
 URI can be specified. Also, the '*' wildcard character is not allowed.

Parameters:
sourceUris - sourceUris or null for none








set
public ExternalDataConfiguration set(String fieldName,
                                     Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public ExternalDataConfiguration 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.

Modifier and Type	Method and Description
`ExternalDataConfiguration`	`clone()`
`Boolean`	`getAutodetect()` Try to detect schema and format options automatically.
`BigtableOptions`	`getBigtableOptions()` [Optional] Additional options if sourceFormat is set to BIGTABLE.
`String`	`getCompression()` [Optional] The compression type of the data source.
`CsvOptions`	`getCsvOptions()` Additional properties to set if sourceFormat is set to CSV.
`GoogleSheetsOptions`	`getGoogleSheetsOptions()` [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`String`	`getHivePartitioningMode()` [Optional, Experimental] If hive partitioning is enabled, which mode to use.
`Boolean`	`getIgnoreUnknownValues()` [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema.
`Integer`	`getMaxBadRecords()` [Optional] The maximum number of bad records that BigQuery can ignore when reading data.
`TableSchema`	`getSchema()` [Optional] The schema for the data.
`String`	`getSourceFormat()` [Required] The data format.
`List<String>`	`getSourceUris()` [Required] The fully-qualified URIs that point to your data in Google Cloud.
`ExternalDataConfiguration`	`set(String fieldName, Object value)`
`ExternalDataConfiguration`	`setAutodetect(Boolean autodetect)` Try to detect schema and format options automatically.
`ExternalDataConfiguration`	`setBigtableOptions(BigtableOptions bigtableOptions)` [Optional] Additional options if sourceFormat is set to BIGTABLE.
`ExternalDataConfiguration`	`setCompression(String compression)` [Optional] The compression type of the data source.
`ExternalDataConfiguration`	`setCsvOptions(CsvOptions csvOptions)` Additional properties to set if sourceFormat is set to CSV.
`ExternalDataConfiguration`	`setGoogleSheetsOptions(GoogleSheetsOptions googleSheetsOptions)` [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
`ExternalDataConfiguration`	`setHivePartitioningMode(String hivePartitioningMode)` [Optional, Experimental] If hive partitioning is enabled, which mode to use.
`ExternalDataConfiguration`	`setIgnoreUnknownValues(Boolean ignoreUnknownValues)` [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema.
`ExternalDataConfiguration`	`setMaxBadRecords(Integer maxBadRecords)` [Optional] The maximum number of bad records that BigQuery can ignore when reading data.
`ExternalDataConfiguration`	`setSchema(TableSchema schema)` [Optional] The schema for the data.
`ExternalDataConfiguration`	`setSourceFormat(String sourceFormat)` [Required] The data format.
`ExternalDataConfiguration`	`setSourceUris(List<String> sourceUris)` [Required] The fully-qualified URIs that point to your data in Google Cloud.