Class: Google::Apis::BigqueryV2::GetQueryResultsResponse

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) ⇒ GetQueryResultsResponse

Returns a new instance of GetQueryResultsResponse.


897
898
899
# File 'generated/google/apis/bigquery_v2/classes.rb', line 897

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)

825
826
827
# File 'generated/google/apis/bigquery_v2/classes.rb', line 825

def cache_hit
  @cache_hit
end

#errorsArray<Google::Apis::BigqueryV2::ErrorProto>

[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful. Corresponds to the JSON property errors


833
834
835
# File 'generated/google/apis/bigquery_v2/classes.rb', line 833

def errors
  @errors
end

#etagString

A hash of this response. Corresponds to the JSON property etag

Returns:

  • (String)

838
839
840
# File 'generated/google/apis/bigquery_v2/classes.rb', line 838

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

844
845
846
# File 'generated/google/apis/bigquery_v2/classes.rb', line 844

def job_complete
  @job_complete
end

#job_referenceGoogle::Apis::BigqueryV2::JobReference

Reference to the BigQuery 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


854
855
856
# File 'generated/google/apis/bigquery_v2/classes.rb', line 854

def job_reference
  @job_reference
end

#kindString

The resource type of the response. Corresponds to the JSON property kind

Returns:

  • (String)

859
860
861
# File 'generated/google/apis/bigquery_v2/classes.rb', line 859

def kind
  @kind
end

#num_dml_affected_rowsString

[Output-only, Experimental] 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:

  • (String)

865
866
867
# File 'generated/google/apis/bigquery_v2/classes.rb', line 865

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)

870
871
872
# File 'generated/google/apis/bigquery_v2/classes.rb', line 870

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. Present only when the query completes successfully. Corresponds to the JSON property rows


878
879
880
# File 'generated/google/apis/bigquery_v2/classes.rb', line 878

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


883
884
885
# File 'generated/google/apis/bigquery_v2/classes.rb', line 883

def schema
  @schema
end

#total_bytes_processedString

The total number of bytes processed for this query. Corresponds to the JSON property totalBytesProcessed

Returns:

  • (String)

888
889
890
# File 'generated/google/apis/bigquery_v2/classes.rb', line 888

def total_bytes_processed
  @total_bytes_processed
end

#total_rowsString

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. Present only when the query completes successfully. Corresponds to the JSON property totalRows

Returns:

  • (String)

895
896
897
# File 'generated/google/apis/bigquery_v2/classes.rb', line 895

def total_rows
  @total_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


902
903
904
905
906
907
908
909
910
911
912
913
914
915
# File 'generated/google/apis/bigquery_v2/classes.rb', line 902

def update!(**args)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @errors = args[:errors] if args.key?(:errors)
  @etag = args[:etag] if args.key?(:etag)
  @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