Class: Google::Apis::BigqueryV2::ExternalDataConfiguration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExternalDataConfiguration

Returns a new instance of ExternalDataConfiguration.



2382
2383
2384
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2382

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#autodetect ⇒ Boolean Also known as: autodetect?

Try to detect schema and format options automatically. Any option specified explicitly will be honored. Corresponds to the JSON property autodetect

Returns:

  • (Boolean) 


2291
2292
2293
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2291

def autodetect
  @autodetect
end

#bigtable_options ⇒ Google::Apis::BigqueryV2::BigtableOptions

[Optional] Additional options if sourceFormat is set to BIGTABLE. Corresponds to the JSON property bigtableOptions

Returns:



2297
2298
2299
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2297

def bigtable_options
  @bigtable_options
end

#compression ⇒ String

[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. Corresponds to the JSON property compression

Returns:

  • (String) 


2304
2305
2306
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2304

def compression
  @compression
end

#connection_id ⇒ String

[Optional, Trusted Tester] Connection for external data source. Corresponds to the JSON property connectionId

Returns:

  • (String) 


2309
2310
2311
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2309

def connection_id
  @connection_id
end

#csv_options ⇒ Google::Apis::BigqueryV2::CsvOptions

Additional properties to set if sourceFormat is set to CSV. Corresponds to the JSON property csvOptions

Returns:



2314
2315
2316
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2314

def csv_options
  @csv_options
end

#google_sheets_options ⇒ Google::Apis::BigqueryV2::GoogleSheetsOptions

[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. Corresponds to the JSON property googleSheetsOptions

Returns:



2319
2320
2321
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2319

def google_sheets_options
  @google_sheets_options
end

#hive_partitioning_options ⇒ Google::Apis::BigqueryV2::HivePartitioningOptions

[Optional] Options to configure hive partitioning support. Corresponds to the JSON property hivePartitioningOptions

Returns:



2324
2325
2326
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2324

def hive_partitioning_options
  @hive_partitioning_options
end

#ignore_unknown_values ⇒ Boolean Also known as: ignore_unknown_values?

[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. Corresponds to the JSON property ignoreUnknownValues

Returns:

  • (Boolean) 


2337
2338
2339
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2337

def ignore_unknown_values
  @ignore_unknown_values
end

#max_bad_records ⇒ Fixnum

[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. Corresponds to the JSON property maxBadRecords

Returns:

  • (Fixnum) 


2348
2349
2350
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2348

def max_bad_records
  @max_bad_records
end

#parquet_options ⇒ Google::Apis::BigqueryV2::ParquetOptions

Additional properties to set if sourceFormat is set to Parquet. Corresponds to the JSON property parquetOptions

Returns:



2353
2354
2355
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2353

def parquet_options
  @parquet_options
end

#schema ⇒ Google::Apis::BigqueryV2::TableSchema

[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. Corresponds to the JSON property schema

Returns:



2360
2361
2362
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2360

def schema
  @schema
end

#source_format ⇒ String

[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". Corresponds to the JSON property sourceFormat

Returns:

  • (String) 


2369
2370
2371
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2369

def source_format
  @source_format
end

#source_uris ⇒ Array<String>

[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. Corresponds to the JSON property sourceUris

Returns:

  • (Array<String>) 


2380
2381
2382
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2380

def source_uris
  @source_uris
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2387

def update!(**args)
  @autodetect = args[:autodetect] if args.key?(:autodetect)
  @bigtable_options = args[:bigtable_options] if args.key?(:bigtable_options)
  @compression = args[:compression] if args.key?(:compression)
  @connection_id = args[:connection_id] if args.key?(:connection_id)
  @csv_options = args[:csv_options] if args.key?(:csv_options)
  @google_sheets_options = args[:google_sheets_options] if args.key?(:google_sheets_options)
  @hive_partitioning_options = args[:hive_partitioning_options] if args.key?(:hive_partitioning_options)
  @ignore_unknown_values = args[:ignore_unknown_values] if args.key?(:ignore_unknown_values)
  @max_bad_records = args[:max_bad_records] if args.key?(:max_bad_records)
  @parquet_options = args[:parquet_options] if args.key?(:parquet_options)
  @schema = args[:schema] if args.key?(:schema)
  @source_format = args[:source_format] if args.key?(:source_format)
  @source_uris = args[:source_uris] if args.key?(:source_uris)
end