Class: Google::Apis::BigqueryV2::QueryResponse

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

Returns a new instance of QueryResponse.



6214
6215
6216
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6214

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

Instance Attribute Details

#cache_hit ⇒ Boolean Also known as: cache_hit?

Whether the query result was fetched from the query cache. Corresponds to the JSON property cacheHit

Returns:

  • (Boolean) 


6136
6137
6138
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6136

def cache_hit
  @cache_hit
end

#dml_stats ⇒ Google::Apis::BigqueryV2::DmlStatistics

[Output-only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE. Corresponds to the JSON property dmlStats

Returns:



6143
6144
6145
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6143

def dml_stats
  @dml_stats
end

#errors ⇒ Array<Google::Apis::BigqueryV2::ErrorProto>

[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. Corresponds to the JSON property errors

Returns:



6151
6152
6153
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6151

def errors
  @errors
end

#job_complete ⇒ Boolean Also known as: job_complete?

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. Corresponds to the JSON property jobComplete

Returns:

  • (Boolean) 


6157
6158
6159
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6157

def job_complete
  @job_complete
end

#job_reference ⇒ Google::Apis::BigqueryV2::JobReference

Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). Corresponds to the JSON property jobReference

Returns:



6167
6168
6169
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6167

def job_reference
  @job_reference
end

#kind ⇒ String

The resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


6172
6173
6174
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6172

def kind
  @kind
end

#num_dml_affected_rows ⇒ Fixnum

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. Corresponds to the JSON property numDmlAffectedRows

Returns:

  • (Fixnum) 


6178
6179
6180
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6178

def num_dml_affected_rows
  @num_dml_affected_rows
end

#page_token ⇒ String

A token used for paging results. Corresponds to the JSON property pageToken

Returns:

  • (String) 


6183
6184
6185
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6183

def page_token
  @page_token
end

#rows ⇒ Array<Google::Apis::BigqueryV2::TableRow>

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Corresponds to the JSON property rows

Returns:



6190
6191
6192
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6190

def rows
  @rows
end

#schema ⇒ Google::Apis::BigqueryV2::TableSchema

The schema of the results. Present only when the query completes successfully. Corresponds to the JSON property schema

Returns:



6195
6196
6197
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6195

def schema
  @schema
end

#session_info ⇒ Google::Apis::BigqueryV2::SessionInfo

[Output-only] [Preview] Information of the session if this job is part of one. Corresponds to the JSON property sessionInfo

Returns:



6200
6201
6202
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6200

def session_info
  @session_info
end

#total_bytes_processed ⇒ Fixnum

The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. Corresponds to the JSON property totalBytesProcessed

Returns:

  • (Fixnum) 


6206
6207
6208
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6206

def total_bytes_processed
  @total_bytes_processed
end

#total_rows ⇒ Fixnum

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Corresponds to the JSON property totalRows

Returns:

  • (Fixnum) 


6212
6213
6214
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6212

def total_rows
  @total_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 6219

def update!(**args)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @dml_stats = args[:dml_stats] if args.key?(:dml_stats)
  @errors = args[:errors] if args.key?(:errors)
  @job_complete = args[:job_complete] if args.key?(:job_complete)
  @job_reference = args[:job_reference] if args.key?(:job_reference)
  @kind = args[:kind] if args.key?(:kind)
  @num_dml_affected_rows = args[:num_dml_affected_rows] if args.key?(:num_dml_affected_rows)
  @page_token = args[:page_token] if args.key?(:page_token)
  @rows = args[:rows] if args.key?(:rows)
  @schema = args[:schema] if args.key?(:schema)
  @session_info = args[:session_info] if args.key?(:session_info)
  @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed)
  @total_rows = args[:total_rows] if args.key?(:total_rows)
end