com.google.api.services.bigquery.model

Class QueryResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.QueryResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class QueryResponse
extends com.google.api.client.json.GenericJson

Model definition for QueryResponse.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
QueryResponse()

Method Summary

Modifier and Type	Method and Description
QueryResponse	clone()
Boolean	getCacheHit() Whether the query result was fetched from the query cache.
List<ErrorProto>	getErrors() [Output-only] The first errors or warnings encountered during the running of the job.
Boolean	getJobComplete() Whether the query has completed or not.
JobReference	getJobReference() Reference to the Job that was created to run the query.
String	getKind() The resource type.
Long	getNumDmlAffectedRows() [Output-only] The number of rows affected by a DML statement.
String	getPageToken() A token used for paging results.
List<TableRow>	getRows() An object with as many results as can be contained within the maximum permitted reply size.
TableSchema	getSchema() The schema of the results.
Long	getTotalBytesProcessed() The total number of bytes processed for this query.
BigInteger	getTotalRows() 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.
QueryResponse	set(String fieldName, Object value)
QueryResponse	setCacheHit(Boolean cacheHit) Whether the query result was fetched from the query cache.
QueryResponse	setErrors(List<ErrorProto> errors) [Output-only] The first errors or warnings encountered during the running of the job.
QueryResponse	setJobComplete(Boolean jobComplete) Whether the query has completed or not.
QueryResponse	setJobReference(JobReference jobReference) Reference to the Job that was created to run the query.
QueryResponse	setKind(String kind) The resource type.
QueryResponse	setNumDmlAffectedRows(Long numDmlAffectedRows) [Output-only] The number of rows affected by a DML statement.
QueryResponse	setPageToken(String pageToken) A token used for paging results.
QueryResponse	setRows(List<TableRow> rows) An object with as many results as can be contained within the maximum permitted reply size.
QueryResponse	setSchema(TableSchema schema) The schema of the results.
QueryResponse	setTotalBytesProcessed(Long totalBytesProcessed) The total number of bytes processed for this query.
QueryResponse	setTotalRows(BigInteger totalRows) 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.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

QueryResponse

public QueryResponse()

Method Detail

getCacheHit

public Boolean getCacheHit()

Whether the query result was fetched from the query cache.

Returns:

value or null for none

setCacheHit

public QueryResponse setCacheHit(Boolean cacheHit)

Whether the query result was fetched from the query cache.

Parameters:

cacheHit - cacheHit or null for none

getErrors

public List<ErrorProto> getErrors()

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

Returns:

value or null for none

setErrors

public QueryResponse setErrors(List<ErrorProto> errors)

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

Parameters:

errors - errors or null for none

getJobComplete

public Boolean getJobComplete()

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.

Returns:

value or null for none

setJobComplete

public QueryResponse setJobComplete(Boolean jobComplete)

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.

Parameters:

jobComplete - jobComplete or null for none

getJobReference

public JobReference getJobReference()

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

Returns:

value or null for none

setJobReference

public QueryResponse setJobReference(JobReference 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).

Parameters:

jobReference - jobReference or null for none

getKind

public String getKind()

The resource type.

Returns:

value or null for none

setKind

public QueryResponse setKind(String kind)

The resource type.

Parameters:

kind - kind or null for none

getNumDmlAffectedRows

public Long getNumDmlAffectedRows()

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

Returns:

value or null for none

setNumDmlAffectedRows

public QueryResponse setNumDmlAffectedRows(Long numDmlAffectedRows)

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

Parameters:

numDmlAffectedRows - numDmlAffectedRows or null for none

getPageToken

public String getPageToken()

A token used for paging results.

Returns:

value or null for none

setPageToken

public QueryResponse setPageToken(String pageToken)

A token used for paging results.

Parameters:

pageToken - pageToken or null for none

getRows

public List<TableRow> getRows()

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.

Returns:

value or null for none

setRows

public QueryResponse setRows(List<TableRow> rows)

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.

Parameters:

rows - rows or null for none

getSchema

public TableSchema getSchema()

The schema of the results. Present only when the query completes successfully.

Returns:

value or null for none

setSchema

public QueryResponse setSchema(TableSchema schema)

The schema of the results. Present only when the query completes successfully.

Parameters:

schema - schema or null for none

getTotalBytesProcessed

public Long getTotalBytesProcessed()

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.

Returns:

value or null for none

setTotalBytesProcessed

public QueryResponse setTotalBytesProcessed(Long totalBytesProcessed)

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.

Parameters:

totalBytesProcessed - totalBytesProcessed or null for none

getTotalRows

public BigInteger getTotalRows()

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.

Returns:

value or null for none

setTotalRows

public QueryResponse setTotalRows(BigInteger totalRows)

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.

Parameters:

totalRows - totalRows or null for none

set

public QueryResponse set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public QueryResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson