com.google.cloud.bigquery

Class QueryResponse

java.lang.Object

com.google.cloud.bigquery.QueryResponse

All Implemented Interfaces:

Serializable

public class QueryResponse
extends Object
implements Serializable

Google Cloud BigQuery Query Response. This class contains the results of a Query Job (BigQuery.getQueryResults(JobId, BigQuery.QueryResultsOption...)) or of a Query Request (BigQuery.query(QueryRequest)).

Example usage of a query response:

 QueryResponse response = bigquery.query(request);
 while (!response.jobCompleted()) {
   Thread.sleep(1000);
   response = bigquery.getQueryResults(response.jobId());
 }
 List<BigQueryError> executionErrors = response.executionErrors();
 // look for errors in executionErrors
 QueryResult result = response.result();
 Iterator<List<FieldValue>> rowIterator = result.iterateAll();
 while(rowIterator.hasNext()) {
   List<FieldValue> row = rowIterator.next();
   // do something with row
 }
 

See Also:

Get Query Results, Query, Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	etag() Returns the hash of the QueryResponse resource or null if not set.
List<BigQueryError>	executionErrors() Returns errors and warnings encountered during the running of the job, if any.
boolean	hasErrors() Returns whether errors and warnings occurred during the execution of the job.
int	hashCode()
boolean	jobCompleted() Returns whether the job running the query has completed or not.
JobId	jobId() Returns the identity of the BigQuery Job that was created to run the query.
QueryResult	result() Returns the result of the query.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

result

public QueryResult result()

Returns the result of the query. Returns null if jobCompleted() is false.

etag

public String etag()

Returns the hash of the QueryResponse resource or null if not set.

jobId

public JobId jobId()

Returns the identity of the BigQuery Job that was created to run the query. This field will be present even if the original request timed out.

jobCompleted

public boolean jobCompleted()

Returns whether the job running the query has completed or not. If result() is not null, this method will always return true. If this method returns false result() returns null. This method can be used to check if query execution completed and results are available.

hasErrors

public boolean hasErrors()

Returns whether errors and warnings occurred during the execution of the job. If this method returns true it does not necessarily mean that the job has completed or was unsuccessful.

executionErrors

public List<BigQueryError> executionErrors()

Returns errors and warnings encountered during the running of the job, if any. Errors here do not necessarily mean that the job has completed or was unsuccessful.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object