bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::ExternalDataConfiguration Class Reference

#include <external_data_configuration.h>

Inheritance diagram for google_bigquery_api::ExternalDataConfiguration:

Public Member Functions

 ExternalDataConfiguration (const Json::Value &storage)
 
 ExternalDataConfiguration (Json::Value *storage)
 
virtual ~ExternalDataConfiguration ()
 
const StringPiece GetTypeName () const
 
bool has_autodetect () const
 
void clear_autodetect ()
 
bool get_autodetect () const
 
void set_autodetect (bool value)
 
bool has_bigtable_options () const
 
void clear_bigtable_options ()
 
const BigtableOptions get_bigtable_options () const
 
BigtableOptions mutable_bigtableOptions ()
 
bool has_compression () const
 
void clear_compression ()
 
const StringPiece get_compression () const
 
void set_compression (const StringPiece &value)
 
bool has_csv_options () const
 
void clear_csv_options ()
 
const CsvOptions get_csv_options () const
 
CsvOptions mutable_csvOptions ()
 
bool has_google_sheets_options () const
 
void clear_google_sheets_options ()
 
const GoogleSheetsOptions get_google_sheets_options () const
 
GoogleSheetsOptions mutable_googleSheetsOptions ()
 
bool has_hive_partitioning_mode () const
 
void clear_hive_partitioning_mode ()
 
const StringPiece get_hive_partitioning_mode () const
 
void set_hive_partitioning_mode (const StringPiece &value)
 
bool has_hive_partitioning_options () const
 
void clear_hive_partitioning_options ()
 
const HivePartitioningOptions get_hive_partitioning_options () const
 
HivePartitioningOptions mutable_hivePartitioningOptions ()
 
bool has_ignore_unknown_values () const
 
void clear_ignore_unknown_values ()
 
bool get_ignore_unknown_values () const
 
void set_ignore_unknown_values (bool value)
 
bool has_max_bad_records () const
 
void clear_max_bad_records ()
 
int32 get_max_bad_records () const
 
void set_max_bad_records (int32 value)
 
bool has_schema () const
 
void clear_schema ()
 
const TableSchema get_schema () const
 
TableSchema mutable_schema ()
 
bool has_source_format () const
 
void clear_source_format ()
 
const StringPiece get_source_format () const
 
void set_source_format (const StringPiece &value)
 
bool has_source_uris () const
 
void clear_source_uris ()
 
const client::JsonCppArray< string > get_source_uris () const
 
client::JsonCppArray< string > mutable_sourceUris ()
 

Static Public Member Functions

static ExternalDataConfigurationNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ ExternalDataConfiguration() [1/2]

google_bigquery_api::ExternalDataConfiguration::ExternalDataConfiguration ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ExternalDataConfiguration() [2/2]

google_bigquery_api::ExternalDataConfiguration::ExternalDataConfiguration ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~ExternalDataConfiguration()

google_bigquery_api::ExternalDataConfiguration::~ExternalDataConfiguration ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_autodetect()

void google_bigquery_api::ExternalDataConfiguration::clear_autodetect ( )
inline

Clears the 'autodetect' attribute.

◆ clear_bigtable_options()

void google_bigquery_api::ExternalDataConfiguration::clear_bigtable_options ( )
inline

Clears the 'bigtableOptions' attribute.

◆ clear_compression()

void google_bigquery_api::ExternalDataConfiguration::clear_compression ( )
inline

Clears the 'compression' attribute.

◆ clear_csv_options()

void google_bigquery_api::ExternalDataConfiguration::clear_csv_options ( )
inline

Clears the 'csvOptions' attribute.

◆ clear_google_sheets_options()

void google_bigquery_api::ExternalDataConfiguration::clear_google_sheets_options ( )
inline

Clears the 'googleSheetsOptions' attribute.

◆ clear_hive_partitioning_mode()

void google_bigquery_api::ExternalDataConfiguration::clear_hive_partitioning_mode ( )
inline

Clears the 'hivePartitioningMode' attribute.

◆ clear_hive_partitioning_options()

void google_bigquery_api::ExternalDataConfiguration::clear_hive_partitioning_options ( )
inline

Clears the 'hivePartitioningOptions' attribute.

◆ clear_ignore_unknown_values()

void google_bigquery_api::ExternalDataConfiguration::clear_ignore_unknown_values ( )
inline

Clears the 'ignoreUnknownValues' attribute.

◆ clear_max_bad_records()

void google_bigquery_api::ExternalDataConfiguration::clear_max_bad_records ( )
inline

Clears the 'maxBadRecords' attribute.

◆ clear_schema()

void google_bigquery_api::ExternalDataConfiguration::clear_schema ( )
inline

Clears the 'schema' attribute.

◆ clear_source_format()

void google_bigquery_api::ExternalDataConfiguration::clear_source_format ( )
inline

Clears the 'sourceFormat' attribute.

◆ clear_source_uris()

void google_bigquery_api::ExternalDataConfiguration::clear_source_uris ( )
inline

Clears the 'sourceUris' attribute.

◆ get_autodetect()

bool google_bigquery_api::ExternalDataConfiguration::get_autodetect ( ) const
inline

Get the value of the 'autodetect' attribute.

◆ get_bigtable_options()

const BigtableOptions google_bigquery_api::ExternalDataConfiguration::get_bigtable_options ( ) const

Get a reference to the value of the 'bigtableOptions' attribute.

◆ get_compression()

const StringPiece google_bigquery_api::ExternalDataConfiguration::get_compression ( ) const
inline

Get the value of the 'compression' attribute.

◆ get_csv_options()

const CsvOptions google_bigquery_api::ExternalDataConfiguration::get_csv_options ( ) const

Get a reference to the value of the 'csvOptions' attribute.

◆ get_google_sheets_options()

const GoogleSheetsOptions google_bigquery_api::ExternalDataConfiguration::get_google_sheets_options ( ) const

Get a reference to the value of the 'googleSheetsOptions' attribute.

◆ get_hive_partitioning_mode()

const StringPiece google_bigquery_api::ExternalDataConfiguration::get_hive_partitioning_mode ( ) const
inline

Get the value of the 'hivePartitioningMode' attribute.

◆ get_hive_partitioning_options()

const HivePartitioningOptions google_bigquery_api::ExternalDataConfiguration::get_hive_partitioning_options ( ) const

Get a reference to the value of the 'hivePartitioningOptions' attribute.

◆ get_ignore_unknown_values()

bool google_bigquery_api::ExternalDataConfiguration::get_ignore_unknown_values ( ) const
inline

Get the value of the 'ignoreUnknownValues' attribute.

◆ get_max_bad_records()

int32 google_bigquery_api::ExternalDataConfiguration::get_max_bad_records ( ) const
inline

Get the value of the 'maxBadRecords' attribute.

◆ get_schema()

const TableSchema google_bigquery_api::ExternalDataConfiguration::get_schema ( ) const

Get a reference to the value of the 'schema' attribute.

◆ get_source_format()

const StringPiece google_bigquery_api::ExternalDataConfiguration::get_source_format ( ) const
inline

Get the value of the 'sourceFormat' attribute.

◆ get_source_uris()

const client::JsonCppArray<string > google_bigquery_api::ExternalDataConfiguration::get_source_uris ( ) const
inline

Get a reference to the value of the 'sourceUris' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::ExternalDataConfiguration::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::ExternalDataConfiguration

◆ has_autodetect()

bool google_bigquery_api::ExternalDataConfiguration::has_autodetect ( ) const
inline

Determine if the 'autodetect' attribute was set.

Returns
true if the 'autodetect' attribute was set.

◆ has_bigtable_options()

bool google_bigquery_api::ExternalDataConfiguration::has_bigtable_options ( ) const
inline

Determine if the 'bigtableOptions' attribute was set.

Returns
true if the 'bigtableOptions' attribute was set.

◆ has_compression()

bool google_bigquery_api::ExternalDataConfiguration::has_compression ( ) const
inline

Determine if the 'compression' attribute was set.

Returns
true if the 'compression' attribute was set.

◆ has_csv_options()

bool google_bigquery_api::ExternalDataConfiguration::has_csv_options ( ) const
inline

Determine if the 'csvOptions' attribute was set.

Returns
true if the 'csvOptions' attribute was set.

◆ has_google_sheets_options()

bool google_bigquery_api::ExternalDataConfiguration::has_google_sheets_options ( ) const
inline

Determine if the 'googleSheetsOptions' attribute was set.

Returns
true if the 'googleSheetsOptions' attribute was set.

◆ has_hive_partitioning_mode()

bool google_bigquery_api::ExternalDataConfiguration::has_hive_partitioning_mode ( ) const
inline

Determine if the 'hivePartitioningMode' attribute was set.

Returns
true if the 'hivePartitioningMode' attribute was set.

◆ has_hive_partitioning_options()

bool google_bigquery_api::ExternalDataConfiguration::has_hive_partitioning_options ( ) const
inline

Determine if the 'hivePartitioningOptions' attribute was set.

Returns
true if the 'hivePartitioningOptions' attribute was set.

◆ has_ignore_unknown_values()

bool google_bigquery_api::ExternalDataConfiguration::has_ignore_unknown_values ( ) const
inline

Determine if the 'ignoreUnknownValues' attribute was set.

Returns
true if the 'ignoreUnknownValues' attribute was set.

◆ has_max_bad_records()

bool google_bigquery_api::ExternalDataConfiguration::has_max_bad_records ( ) const
inline

Determine if the 'maxBadRecords' attribute was set.

Returns
true if the 'maxBadRecords' attribute was set.

◆ has_schema()

bool google_bigquery_api::ExternalDataConfiguration::has_schema ( ) const
inline

Determine if the 'schema' attribute was set.

Returns
true if the 'schema' attribute was set.

◆ has_source_format()

bool google_bigquery_api::ExternalDataConfiguration::has_source_format ( ) const
inline

Determine if the 'sourceFormat' attribute was set.

Returns
true if the 'sourceFormat' attribute was set.

◆ has_source_uris()

bool google_bigquery_api::ExternalDataConfiguration::has_source_uris ( ) const
inline

Determine if the 'sourceUris' attribute was set.

Returns
true if the 'sourceUris' attribute was set.

◆ mutable_bigtableOptions()

BigtableOptions google_bigquery_api::ExternalDataConfiguration::mutable_bigtableOptions ( )

Gets a reference to a mutable value of the 'bigtableOptions' property.

[Optional] Additional options if sourceFormat is set to BIGTABLE.

Returns
The result can be modified to change the attribute value.

◆ mutable_csvOptions()

CsvOptions google_bigquery_api::ExternalDataConfiguration::mutable_csvOptions ( )

Gets a reference to a mutable value of the 'csvOptions' property.

Additional properties to set if sourceFormat is set to CSV.

Returns
The result can be modified to change the attribute value.

◆ mutable_googleSheetsOptions()

GoogleSheetsOptions google_bigquery_api::ExternalDataConfiguration::mutable_googleSheetsOptions ( )

Gets a reference to a mutable value of the 'googleSheetsOptions' property.

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

Returns
The result can be modified to change the attribute value.

◆ mutable_hivePartitioningOptions()

HivePartitioningOptions google_bigquery_api::ExternalDataConfiguration::mutable_hivePartitioningOptions ( )

Gets a reference to a mutable value of the 'hivePartitioningOptions' property.

[Optional, Trusted Tester] Options to configure hive partitioning support.

Returns
The result can be modified to change the attribute value.

◆ mutable_schema()

TableSchema google_bigquery_api::ExternalDataConfiguration::mutable_schema ( )

Gets a reference to a mutable value of the 'schema' property.

[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
The result can be modified to change the attribute value.

◆ mutable_sourceUris()

client::JsonCppArray<string > google_bigquery_api::ExternalDataConfiguration::mutable_sourceUris ( )
inline

Gets a reference to a mutable value of the 'sourceUris' property.

[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
The result can be modified to change the attribute value.

◆ New()

ExternalDataConfiguration * google_bigquery_api::ExternalDataConfiguration::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_autodetect()

void google_bigquery_api::ExternalDataConfiguration::set_autodetect ( bool  value)
inline

Change the 'autodetect' attribute.

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

Parameters
[in]valueThe new value.

◆ set_compression()

void google_bigquery_api::ExternalDataConfiguration::set_compression ( const StringPiece &  value)
inline

Change the 'compression' attribute.

[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
[in]valueThe new value.

◆ set_hive_partitioning_mode()

void google_bigquery_api::ExternalDataConfiguration::set_hive_partitioning_mode ( const StringPiece &  value)
inline

Change the 'hivePartitioningMode' attribute.

[Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead.

Parameters
[in]valueThe new value.

◆ set_ignore_unknown_values()

void google_bigquery_api::ExternalDataConfiguration::set_ignore_unknown_values ( bool  value)
inline

Change the 'ignoreUnknownValues' attribute.

[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
[in]valueThe new value.

◆ set_max_bad_records()

void google_bigquery_api::ExternalDataConfiguration::set_max_bad_records ( int32  value)
inline

Change the 'maxBadRecords' attribute.

[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
[in]valueThe new value.

◆ set_source_format()

void google_bigquery_api::ExternalDataConfiguration::set_source_format ( const StringPiece &  value)
inline

Change the 'sourceFormat' attribute.

[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
[in]valueThe new value.

The documentation for this class was generated from the following files: