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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ JobConfiguration

Returns a new instance of JobConfiguration



1909
1910
1911
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1909

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:



1862
1863
1864
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1862

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) 


1870
1871
1872
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1870

def dry_run
  @dry_run
end

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

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

Returns:



1876
1877
1878
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1876

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) 


1882
1883
1884
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1882

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) 


1888
1889
1890
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1888

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


1897
1898
1899
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1897

def labels
  @labels
end

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

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

Returns:



1902
1903
1904
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1902

def load
  @load
end

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

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

Returns:



1907
1908
1909
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1907

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1914

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