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.



3776
3777
3778
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3776

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

Instance Attribute Details

#copyGoogle::Apis::BigqueryV2::JobConfigurationTableCopy

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



3729
3730
3731
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3729

def copy
  @copy
end

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


3737
3738
3739
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3737

def dry_run
  @dry_run
end

#extractGoogle::Apis::BigqueryV2::JobConfigurationExtract

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



3743
3744
3745
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3743

def extract
  @extract
end

#job_timeout_msFixnum

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


3749
3750
3751
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3749

def job_timeout_ms
  @job_timeout_ms
end

#job_typeString

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

Returns:

  • (String)


3755
3756
3757
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3755

def job_type
  @job_type
end

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


3764
3765
3766
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3764

def labels
  @labels
end

#loadGoogle::Apis::BigqueryV2::JobConfigurationLoad

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



3769
3770
3771
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3769

def load
  @load
end

#queryGoogle::Apis::BigqueryV2::JobConfigurationQuery

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



3774
3775
3776
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3774

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
# File 'lib/google/apis/bigquery_v2/classes.rb', line 3781

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