Class: Google::Apis::BigqueryV2::JobConfigurationExtract

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

Overview

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JobConfigurationExtract

Returns a new instance of JobConfigurationExtract.



4489
4490
4491
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4489

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

Instance Attribute Details

#compression ⇒ String

Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models. Corresponds to the JSON property compression

Returns:

  • (String) 


4429
4430
4431
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4429

def compression
  @compression
end

#destination_format ⇒ String

Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. Corresponds to the JSON property destinationFormat

Returns:

  • (String) 


4438
4439
4440
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4438

def destination_format
  @destination_format
end

#destination_uri ⇒ String

[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. Corresponds to the JSON property destinationUri

Returns:

  • (String) 


4445
4446
4447
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4445

def destination_uri
  @destination_uri
end

#destination_uris ⇒ Array<String>

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. Corresponds to the JSON property destinationUris

Returns:

  • (Array<String>) 


4451
4452
4453
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4451

def destination_uris
  @destination_uris
end

#field_delimiter ⇒ String

Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. Corresponds to the JSON property fieldDelimiter

Returns:

  • (String) 


4458
4459
4460
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4458

def field_delimiter
  @field_delimiter
end

#model_extract_options ⇒ Google::Apis::BigqueryV2::ModelExtractOptions

Options related to model extraction. Corresponds to the JSON property modelExtractOptions

Returns:



4463
4464
4465
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4463

def model_extract_options
  @model_extract_options
end

#print_header ⇒ Boolean Also known as: print_header?

Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. Corresponds to the JSON property printHeader

Returns:

  • (Boolean) 


4469
4470
4471
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4469

def print_header
  @print_header
end

#source_model ⇒ Google::Apis::BigqueryV2::ModelReference

Id path of a model. Corresponds to the JSON property sourceModel

Returns:



4475
4476
4477
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4475

def source_model
  @source_model
end

#source_table ⇒ Google::Apis::BigqueryV2::TableReference

A reference to the table being exported. Corresponds to the JSON property sourceTable

Returns:



4480
4481
4482
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4480

def source_table
  @source_table
end

#use_avro_logical_types ⇒ Boolean Also known as: use_avro_logical_types?

Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. Corresponds to the JSON property useAvroLogicalTypes

Returns:

  • (Boolean) 


4486
4487
4488
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4486

def use_avro_logical_types
  @use_avro_logical_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4494

def update!(**args)
  @compression = args[:compression] if args.key?(:compression)
  @destination_format = args[:destination_format] if args.key?(:destination_format)
  @destination_uri = args[:destination_uri] if args.key?(:destination_uri)
  @destination_uris = args[:destination_uris] if args.key?(:destination_uris)
  @field_delimiter = args[:field_delimiter] if args.key?(:field_delimiter)
  @model_extract_options = args[:model_extract_options] if args.key?(:model_extract_options)
  @print_header = args[:print_header] if args.key?(:print_header)
  @source_model = args[:source_model] if args.key?(:source_model)
  @source_table = args[:source_table] if args.key?(:source_table)
  @use_avro_logical_types = args[:use_avro_logical_types] if args.key?(:use_avro_logical_types)
end