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

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

Returns a new instance of JobConfiguration.



4411
4412
4413
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4411

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

Instance Attribute Details

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

JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see Copy a table. Corresponds to the JSON property copy

Returns:



4360
4361
4362
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4360

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) 


4368
4369
4370
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4368

def dry_run
  @dry_run
end

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

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage. Corresponds to the JSON property extract

Returns:



4375
4376
4377
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4375

def extract
  @extract
end

#job_timeout_ms ⇒ Fixnum

Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. Corresponds to the JSON property jobTimeoutMs

Returns:

  • (Fixnum) 


4384
4385
4386
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4384

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) 


4389
4390
4391
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4389

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


4398
4399
4400
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4398

def labels
  @labels
end

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

JobConfigurationLoad contains the configuration properties for loading data into a destination table. Corresponds to the JSON property load

Returns:



4404
4405
4406
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4404

def load
  @load
end

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

JobConfigurationQuery configures a BigQuery query job. Corresponds to the JSON property query

Returns:



4409
4410
4411
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4409

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4416

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