Class: Google::Apis::BigqueryV2::GetQueryResultsResponse

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

Returns a new instance of GetQueryResultsResponse



1314
1315
1316
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1314

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) 


1241
1242
1243
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1241

def cache_hit
  @cache_hit
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:



1250
1251
1252
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1250

def errors
  @errors
end

#etag ⇒ String

A hash of this response. Corresponds to the JSON property etag

Returns:

  • (String) 


1255
1256
1257
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1255

def etag
  @etag
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) 


1261
1262
1263
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1261

def job_complete
  @job_complete
end

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

Reference to the BigQuery 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:



1271
1272
1273
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1271

def job_reference
  @job_reference
end

#kind ⇒ String

The resource type of the response. Corresponds to the JSON property kind

Returns:

  • (String) 


1276
1277
1278
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1276

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) 


1282
1283
1284
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1282

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) 


1287
1288
1289
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1287

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. Present only when the query completes successfully. Corresponds to the JSON property rows

Returns:



1295
1296
1297
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1295

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:



1300
1301
1302
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1300

def schema
  @schema
end

#total_bytes_processed ⇒ Fixnum

The total number of bytes processed for this query. Corresponds to the JSON property totalBytesProcessed

Returns:

  • (Fixnum) 


1305
1306
1307
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1305

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. Present only when the query completes successfully. Corresponds to the JSON property totalRows

Returns:

  • (Fixnum) 


1312
1313
1314
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1312

def total_rows
  @total_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'generated/google/apis/bigquery_v2/classes.rb', line 1319

def update!(**args)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @errors = args[:errors] if args.key?(:errors)
  @etag = args[:etag] if args.key?(:etag)
  @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)
  @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed)
  @total_rows = args[:total_rows] if args.key?(:total_rows)
end