Class: Google::Apis::BigqueryV2::JobConfiguration

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

Constructor Details

#initialize(**args) ⇒ JobConfiguration

Returns a new instance of JobConfiguration.



2802
2803
2804
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2802

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

Instance Attribute Details

#copy ⇒ Google::Apis::BigqueryV2::JobConfigurationTableCopy

[Pick one] Copies a table. Corresponds to the JSON property copy

Returns:



2755
2756
2757
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2755

def copy
  @copy
end

#dry_run ⇒ Boolean Also known as: dry_run?

[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non- query jobs is undefined. Corresponds to the JSON property dryRun

Returns:

  • (Boolean) 


2763
2764
2765
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2763

def dry_run
  @dry_run
end

#extract ⇒ Google::Apis::BigqueryV2::JobConfigurationExtract

[Pick one] Configures an extract job. Corresponds to the JSON property extract

Returns:



2769
2770
2771
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2769

def extract
  @extract
end

#job_timeout_ms ⇒ Fixnum

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. Corresponds to the JSON property jobTimeoutMs

Returns:

  • (Fixnum) 


2775
2776
2777
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2775

def job_timeout_ms
  @job_timeout_ms
end

#job_type ⇒ String

[Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. Corresponds to the JSON property jobType

Returns:

  • (String) 


2781
2782
2783
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2781

def job_type
  @job_type
end

#labels ⇒ Hash<String,String>

The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2790
2791
2792
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2790

def labels
  @labels
end

#load ⇒ Google::Apis::BigqueryV2::JobConfigurationLoad

[Pick one] Configures a load job. Corresponds to the JSON property load

Returns:



2795
2796
2797
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2795

def load
  @load
end

#query ⇒ Google::Apis::BigqueryV2::JobConfigurationQuery

[Pick one] Configures a query job. Corresponds to the JSON property query

Returns:



2800
2801
2802
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2800

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2807

def update!(**args)
  @copy = args[:copy] if args.key?(:copy)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @extract = args[:extract] if args.key?(:extract)
  @job_timeout_ms = args[:job_timeout_ms] if args.key?(:job_timeout_ms)
  @job_type = args[:job_type] if args.key?(:job_type)
  @labels = args[:labels] if args.key?(:labels)
  @load = args[:load] if args.key?(:load)
  @query = args[:query] if args.key?(:query)
end