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.



4269
4270
4271
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4269

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:



4221
4222
4223
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4221

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) 


4229
4230
4231
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4229

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:



4236
4237
4238
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4236

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) 


4242
4243
4244
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4242

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) 


4247
4248
4249
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4247

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


4256
4257
4258
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4256

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:



4262
4263
4264
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4262

def load
  @load
end

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

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

Returns:



4267
4268
4269
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4267

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 4274

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