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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JobConfigurationExtract

Returns a new instance of JobConfigurationExtract.



3741
3742
3743
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3741

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. Not applicable when extracting models. Corresponds to the JSON property compression

Returns:

  • (String) 


3685
3686
3687
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3685

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) 


3694
3695
3696
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3694

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) 


3701
3702
3703
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3701

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


3707
3708
3709
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3707

def destination_uris
  @destination_uris
end

#field_delimiter ⇒ String

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

Returns:

  • (String) 


3713
3714
3715
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3713

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. Not applicable when extracting models. Corresponds to the JSON property printHeader

Returns:

  • (Boolean) 


3719
3720
3721
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3719

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:



3725
3726
3727
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3725

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:



3730
3731
3732
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3730

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). Not applicable when extracting models. Corresponds to the JSON property useAvroLogicalTypes

Returns:

  • (Boolean) 


3738
3739
3740
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3738

def use_avro_logical_types
  @use_avro_logical_types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3746

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