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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryResponse

Returns a new instance of QueryResponse.



8953
8954
8955
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8953

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

Instance Attribute Details

#arrow_record_batch ⇒ Google::Apis::BigqueryV2::ArrowRecordBatch

Arrow RecordBatch. This feature is not yet available. Corresponds to the JSON property arrowRecordBatch

Returns:



8803
8804
8805
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8803

def arrow_record_batch
  @arrow_record_batch
end

#arrow_schema ⇒ Google::Apis::BigqueryV2::ArrowSchema

Arrow schema as specified in https://arrow.apache.org/docs/python/api/ datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/ docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available. Corresponds to the JSON property arrowSchema

Returns:



8812
8813
8814
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8812

def arrow_schema
  @arrow_schema
end

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


8817
8818
8819
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8817

def cache_hit
  @cache_hit
end

#creation_time ⇒ Fixnum

Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries. Corresponds to the JSON property creationTime

Returns:

  • (Fixnum) 


8824
8825
8826
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8824

def creation_time
  @creation_time
end

#dml_stats ⇒ Google::Apis::BigqueryV2::DmlStatistics

Detailed statistics for DML statements Corresponds to the JSON property dmlStats

Returns:



8829
8830
8831
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8829

def dml_stats
  @dml_stats
end

#end_time ⇒ Fixnum

Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state. Corresponds to the JSON property endTime

Returns:

  • (Fixnum) 


8835
8836
8837
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8835

def end_time
  @end_time
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. For more information about error messages, see Error messages. Corresponds to the JSON property errors

Returns:



8844
8845
8846
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8844

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

Returns:

  • (Boolean) 


8850
8851
8852
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8850

def job_complete
  @job_complete
end

#job_creation_reason ⇒ Google::Apis::BigqueryV2::JobCreationReason

Reason about why a Job was created from a jobs.query method when used with JOB_CREATION_OPTIONAL Job creation mode. For jobs.insert method calls it will always be REQUESTED. Corresponds to the JSON property jobCreationReason

Returns:



8860
8861
8862
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8860

def job_creation_reason
  @job_creation_reason
end

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

A job reference is a fully qualified identifier for referring to a job. Corresponds to the JSON property jobReference

Returns:



8865
8866
8867
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8865

def job_reference
  @job_reference
end

#kind ⇒ String

The resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


8870
8871
8872
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8870

def kind
  @kind
end

#location ⇒ String

Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations Corresponds to the JSON property location

Returns:

  • (String) 


8876
8877
8878
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8876

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


8882
8883
8884
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8882

def num_dml_affected_rows
  @num_dml_affected_rows
end

#page_row_count ⇒ Fixnum

Output only. The number of rows out of total_rows returned in this response. This feature is not yet available. Corresponds to the JSON property pageRowCount

Returns:

  • (Fixnum) 


8888
8889
8890
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8888

def page_row_count
  @page_row_count
end

#page_token ⇒ String

A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the jobs. getQueryResults method. For more information, see Paging through table data. Corresponds to the JSON property pageToken

Returns:

  • (String) 


8897
8898
8899
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8897

def page_token
  @page_token
end

#query_id ⇒ String

Auto-generated ID for the query. Corresponds to the JSON property queryId

Returns:

  • (String) 


8902
8903
8904
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8902

def query_id
  @query_id
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

Returns:



8909
8910
8911
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8909

def rows
  @rows
end

#schema ⇒ Google::Apis::BigqueryV2::TableSchema

Schema of a table Corresponds to the JSON property schema

Returns:



8914
8915
8916
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8914

def schema
  @schema
end

#session_info ⇒ Google::Apis::BigqueryV2::SessionInfo

[Preview] Information related to sessions. Corresponds to the JSON property sessionInfo

Returns:



8919
8920
8921
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8919

def session_info
  @session_info
end

#start_time ⇒ Fixnum

Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE. Corresponds to the JSON property startTime

Returns:

  • (Fixnum) 


8926
8927
8928
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8926

def start_time
  @start_time
end

#total_bytes_billed ⇒ Fixnum

Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only. Corresponds to the JSON property totalBytesBilled

Returns:

  • (Fixnum) 


8934
8935
8936
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8934

def total_bytes_billed
  @total_bytes_billed
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

Returns:

  • (Fixnum) 


8940
8941
8942
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8940

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

Returns:

  • (Fixnum) 


8946
8947
8948
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8946

def total_rows
  @total_rows
end

#total_slot_ms ⇒ Fixnum

Output only. Number of slot ms the user is actually billed for. Corresponds to the JSON property totalSlotMs

Returns:

  • (Fixnum) 


8951
8952
8953
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8951

def total_slot_ms
  @total_slot_ms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 8958

def update!(**args)
  @arrow_record_batch = args[:arrow_record_batch] if args.key?(:arrow_record_batch)
  @arrow_schema = args[:arrow_schema] if args.key?(:arrow_schema)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @dml_stats = args[:dml_stats] if args.key?(:dml_stats)
  @end_time = args[:end_time] if args.key?(:end_time)
  @errors = args[:errors] if args.key?(:errors)
  @job_complete = args[:job_complete] if args.key?(:job_complete)
  @job_creation_reason = args[:job_creation_reason] if args.key?(:job_creation_reason)
  @job_reference = args[:job_reference] if args.key?(:job_reference)
  @kind = args[:kind] if args.key?(:kind)
  @location = args[:location] if args.key?(:location)
  @num_dml_affected_rows = args[:num_dml_affected_rows] if args.key?(:num_dml_affected_rows)
  @page_row_count = args[:page_row_count] if args.key?(:page_row_count)
  @page_token = args[:page_token] if args.key?(:page_token)
  @query_id = args[:query_id] if args.key?(:query_id)
  @rows = args[:rows] if args.key?(:rows)
  @schema = args[:schema] if args.key?(:schema)
  @session_info = args[:session_info] if args.key?(:session_info)
  @start_time = args[:start_time] if args.key?(:start_time)
  @total_bytes_billed = args[:total_bytes_billed] if args.key?(:total_bytes_billed)
  @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed)
  @total_rows = args[:total_rows] if args.key?(:total_rows)
  @total_slot_ms = args[:total_slot_ms] if args.key?(:total_slot_ms)
end