Class: Google::Apis::BigqueryV2::QueryResponse
- Inherits:
-
Object
- Object
- Google::Apis::BigqueryV2::QueryResponse
- 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
-
#cache_hit ⇒ Boolean
(also: #cache_hit?)
Whether the query result was fetched from the query cache.
-
#errors ⇒ Array<Google::Apis::BigqueryV2::ErrorProto>
[Output-only] The first errors or warnings encountered during the running of the job.
-
#job_complete ⇒ Boolean
(also: #job_complete?)
Whether the query has completed or not.
-
#job_reference ⇒ Google::Apis::BigqueryV2::JobReference
Reference to the Job that was created to run the query.
-
#kind ⇒ String
The resource type.
-
#num_dml_affected_rows ⇒ Fixnum
[Output-only] The number of rows affected by a DML statement.
-
#page_token ⇒ String
A token used for paging results.
-
#rows ⇒ Array<Google::Apis::BigqueryV2::TableRow>
An object with as many results as can be contained within the maximum permitted reply size.
-
#schema ⇒ Google::Apis::BigqueryV2::TableSchema
The schema of the results.
-
#total_bytes_processed ⇒ Fixnum
The total number of bytes processed for this query.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QueryResponse
constructor
A new instance of QueryResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ QueryResponse
Returns a new instance of QueryResponse
4094 4095 4096 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4094 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
4027 4028 4029 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4027 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
4036 4037 4038 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4036 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
4042 4043 4044 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4042 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
4052 4053 4054 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4052 def job_reference @job_reference end |
#kind ⇒ String
The resource type.
Corresponds to the JSON property kind
4057 4058 4059 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4057 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
4063 4064 4065 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4063 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
4068 4069 4070 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4068 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
4075 4076 4077 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4075 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
4080 4081 4082 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4080 def schema @schema 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
4086 4087 4088 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4086 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
4092 4093 4094 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4092 def total_rows @total_rows end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4099 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 |