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



2141
2142
2143
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2141

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

Instance Attribute Details

#copyGoogle::Apis::BigqueryV2::JobConfigurationTableCopy

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



2094
2095
2096
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2094

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)


2102
2103
2104
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2102

def dry_run
  @dry_run
end

#extractGoogle::Apis::BigqueryV2::JobConfigurationExtract

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



2108
2109
2110
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2108

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)


2114
2115
2116
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2114

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)


2120
2121
2122
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2120

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


2129
2130
2131
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2129

def labels
  @labels
end

#loadGoogle::Apis::BigqueryV2::JobConfigurationLoad

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



2134
2135
2136
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2134

def load
  @load
end

#queryGoogle::Apis::BigqueryV2::JobConfigurationQuery

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



2139
2140
2141
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2139

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2146

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