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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ JobConfigurationExtract

Returns a new instance of JobConfigurationExtract



2381
2382
2383
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2381

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

Instance Attribute Details

#compression ⇒ String

[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Corresponds to the JSON property compression

Returns:

  • (String) 


2329
2330
2331
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2329

def compression
  @compression
end

#destination_format ⇒ String

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

Returns:

  • (String) 


2336
2337
2338
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2336

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) 


2343
2344
2345
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2343

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


2349
2350
2351
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2349

def destination_uris
  @destination_uris
end

#field_delimiter ⇒ String

[Optional] Delimiter to use between fields in the exported data. Default is ',' Corresponds to the JSON property fieldDelimiter

Returns:

  • (String) 


2354
2355
2356
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2354

def field_delimiter
  @field_delimiter
end

#print_header ⇒ Boolean Also known as: print_header?

[Optional] Whether to print out a header row in the results. Default is true. Corresponds to the JSON property printHeader

Returns:

  • (Boolean) 


2359
2360
2361
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2359

def print_header
  @print_header
end

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

A reference to the model being exported. Corresponds to the JSON property sourceModel

Returns:



2365
2366
2367
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2365

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:



2370
2371
2372
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2370

def source_table
  @source_table
end

#use_avro_logical_types ⇒ Boolean Also known as: use_avro_logical_types?

[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Corresponds to the JSON property useAvroLogicalTypes

Returns:

  • (Boolean) 


2378
2379
2380
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2378

def use_avro_logical_types
  @use_avro_logical_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2386

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