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.


4880
4881
4882
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4880

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)

4813
4814
4815
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4813

def cache_hit
  @cache_hit
end

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


4822
4823
4824
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4822

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)

4828
4829
4830
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4828

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


4838
4839
4840
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4838

def job_reference
  @job_reference
end

#kindString

The resource type. Corresponds to the JSON property kind

Returns:

  • (String)

4843
4844
4845
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4843

def kind
  @kind
end

#num_dml_affected_rowsFixnum

[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)

4849
4850
4851
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4849

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)

4854
4855
4856
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4854

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


4861
4862
4863
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4861

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


4866
4867
4868
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4866

def schema
  @schema
end

#total_bytes_processedFixnum

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)

4872
4873
4874
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4872

def total_bytes_processed
  @total_bytes_processed
end

#total_rowsFixnum

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)

4878
4879
4880
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4878

def total_rows
  @total_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4885

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