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
2758 2759 2760 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2758 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
2691 2692 2693 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2691 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
2700 2701 2702 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2700 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
2706 2707 2708 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2706 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
2716 2717 2718 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2716 def job_reference @job_reference end |
#kind ⇒ String
The resource type.
Corresponds to the JSON property kind
2721 2722 2723 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2721 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
2727 2728 2729 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2727 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
2732 2733 2734 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2732 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
2739 2740 2741 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2739 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
2744 2745 2746 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2744 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
2750 2751 2752 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2750 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
2756 2757 2758 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2756 def total_rows @total_rows end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 2763 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 |