com.google.api.services.bigquery.model

Class GetQueryResultsResponse

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.GetQueryResultsResponse

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Model definition for GetQueryResultsResponse.

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GetQueryResultsResponse()

Method Summary

Methods

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

Constructor Detail

GetQueryResultsResponse

public GetQueryResultsResponse()

Method Detail

getCacheHit

public java.lang.Boolean getCacheHit()

Whether the query result was fetched from the query cache.

Returns:

value or null for none

setCacheHit

public GetQueryResultsResponse setCacheHit(java.lang.Boolean cacheHit)

Whether the query result was fetched from the query cache.

Parameters:

cacheHit - cacheHit or null for none

getErrors

public java.util.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 GetQueryResultsResponse setErrors(java.util.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

getEtag

public java.lang.String getEtag()

A hash of this response.

Returns:

value or null for none

setEtag

public GetQueryResultsResponse setEtag(java.lang.String etag)

A hash of this response.

Parameters:

etag - etag or null for none

getJobComplete

public java.lang.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 GetQueryResultsResponse setJobComplete(java.lang.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 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).

Returns:

value or null for none

setJobReference

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

Parameters:

jobReference - jobReference or null for none

getKind

public java.lang.String getKind()

The resource type of the response.

Returns:

value or null for none

setKind

public GetQueryResultsResponse setKind(java.lang.String kind)

The resource type of the response.

Parameters:

kind - kind or null for none

getNumDmlAffectedRows

public java.lang.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 GetQueryResultsResponse setNumDmlAffectedRows(java.lang.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 java.lang.String getPageToken()

A token used for paging results.

Returns:

value or null for none

setPageToken

public GetQueryResultsResponse setPageToken(java.lang.String pageToken)

A token used for paging results.

Parameters:

pageToken - pageToken or null for none

getRows

public java.util.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. Present only when the query completes successfully.

Returns:

value or null for none

setRows

public GetQueryResultsResponse setRows(java.util.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. Present only when the query completes successfully.

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 GetQueryResultsResponse setSchema(TableSchema schema)

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

Parameters:

schema - schema or null for none

getTotalBytesProcessed

public java.lang.Long getTotalBytesProcessed()

The total number of bytes processed for this query.

Returns:

value or null for none

setTotalBytesProcessed

public GetQueryResultsResponse setTotalBytesProcessed(java.lang.Long totalBytesProcessed)

The total number of bytes processed for this query.

Parameters:

totalBytesProcessed - totalBytesProcessed or null for none

getTotalRows

public java.math.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. Present only when the query completes successfully.

Returns:

value or null for none

setTotalRows

public GetQueryResultsResponse setTotalRows(java.math.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. Present only when the query completes successfully.

Parameters:

totalRows - totalRows or null for none

set

public GetQueryResultsResponse set(java.lang.String fieldName,
                          java.lang.Object value)

Overrides:

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

clone

public GetQueryResultsResponse clone()

Overrides:

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