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

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

Returns a new instance of QueryResponse.


2336
2337
2338
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2336

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

Instance Attribute Details

#cache_hitBoolean Also known as: cache_hit?

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

Returns:

  • (Boolean)

2270
2271
2272
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2270

def cache_hit
  @cache_hit
end

#errorsArray<Google::Apis::BigqueryV2::ErrorProto>

[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful. Corresponds to the JSON property errors


2278
2279
2280
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2278

def errors
  @errors
end

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

2284
2285
2286
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2284

def job_complete
  @job_complete
end

#job_referenceGoogle::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


2294
2295
2296
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2294

def job_reference
  @job_reference
end

#kindString

The resource type. Corresponds to the JSON property kind

Returns:

  • (String)

2299
2300
2301
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2299

def kind
  @kind
end

#num_dml_affected_rowsString

[Output-only, Experimental] 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:

  • (String)

2305
2306
2307
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2305

def num_dml_affected_rows
  @num_dml_affected_rows
end

#page_tokenString

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

Returns:

  • (String)

2310
2311
2312
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2310

def page_token
  @page_token
end

#rowsArray<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


2317
2318
2319
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2317

def rows
  @rows
end

#schemaGoogle::Apis::BigqueryV2::TableSchema

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


2322
2323
2324
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2322

def schema
  @schema
end

#total_bytes_processedString

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:

  • (String)

2328
2329
2330
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2328

def total_bytes_processed
  @total_bytes_processed
end

#total_rowsString

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:

  • (String)

2334
2335
2336
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2334

def total_rows
  @total_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2341

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