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.



4322
4323
4324
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4322

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:



4274
4275
4276
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4274

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) 


4282
4283
4284
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4282

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:



4289
4290
4291
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4289

def extract
  @extract
end

#job_timeout_ms ⇒ Fixnum

Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. Corresponds to the JSON property jobTimeoutMs

Returns:

  • (Fixnum) 


4295
4296
4297
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4295

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) 


4300
4301
4302
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4300

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


4309
4310
4311
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4309

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:



4315
4316
4317
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4315

def load
  @load
end

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

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

Returns:



4320
4321
4322
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4320

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4327

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