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.



9047
9048
9049
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9047

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:



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

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:



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

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) 


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

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) 


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

def creation_time
  @creation_time
end

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

Detailed statistics for DML statements Corresponds to the JSON property dmlStats

Returns:



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

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) 


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

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:



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

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) 


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

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:



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

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:



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

def job_reference
  @job_reference
end

#kind ⇒ String

The resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def page_token
  @page_token
end

#query_id ⇒ String

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

Returns:

  • (String) 


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

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:



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

def rows
  @rows
end

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

Schema of a table Corresponds to the JSON property schema

Returns:



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

def schema
  @schema
end

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

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

Returns:



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

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) 


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

def start_time
  @start_time
end

#statement_type ⇒ String

Output only. The type of query statement, if valid. Possible values: * SELECT : SELECT statement. * ASSERT: ASSERT statement. * INSERT: INSERT statement. * UPDATE: UPDATE statement. * DELETE: DELETE statement. * MERGE: MERGE statement. * CREATE_TABLE: CREATE TABLE statement, without AS SELECT. * CREATE_TABLE_AS_SELECT: CREATE TABLE AS SELECT statement. * CREATE_VIEW: CREATE VIEW statement. * CREATE_MODEL: CREATE MODEL statement. * CREATE_MATERIALIZED_VIEW: CREATE MATERIALIZED VIEW statement. * CREATE_FUNCTION: CREATE FUNCTION statement. * CREATE_TABLE_FUNCTION: CREATE TABLE FUNCTION statement. * CREATE_PROCEDURE: CREATE PROCEDURE statement. * CREATE_ROW_ACCESS_POLICY: CREATE ROW ACCESS POLICY statement. * CREATE_SCHEMA: CREATE SCHEMA statement. * CREATE_SNAPSHOT_TABLE: CREATE SNAPSHOT TABLE statement. * CREATE_SEARCH_INDEX: CREATE SEARCH INDEX statement. * DROP_TABLE: DROP TABLE statement. * DROP_EXTERNAL_TABLE: DROP EXTERNAL TABLE statement. * DROP_VIEW: DROP VIEW statement. * DROP_MODEL: DROP MODEL statement. * DROP_MATERIALIZED_VIEW: DROP MATERIALIZED VIEW statement. * DROP_FUNCTION : DROP FUNCTION statement. * DROP_TABLE_FUNCTION : DROP TABLE FUNCTION statement. * DROP_PROCEDURE: DROP PROCEDURE statement. * DROP_SEARCH_INDEX: DROP SEARCH INDEX statement. * DROP_SCHEMA: DROP SCHEMA statement. * DROP_SNAPSHOT_TABLE: DROP SNAPSHOT TABLE statement.

Returns:

  • (String) 


9020
9021
9022
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9020

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


9028
9029
9030
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9028

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) 


9034
9035
9036
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9034

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) 


9040
9041
9042
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9040

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) 


9045
9046
9047
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9045

def total_slot_ms
  @total_slot_ms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 9052

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)
  @statement_type = args[:statement_type] if args.key?(:statement_type)
  @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