GetQueryResultsResponse (BigQuery API v2-rev20251012-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GetQueryResultsResponse
extends com.google.api.client.json.GenericJson
```
Response object of GetQueryResults.
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

GetQueryResultsResponse()

Constructors
Constructor and Description
`GetQueryResultsResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetQueryResultsResponse`	`clone()`
`Boolean`	`getCacheHit()` Whether the query result was fetched from the query cache.
`List<ErrorProto>`	`getErrors()` Output only.
`String`	`getEtag()` A hash of this response.
`Boolean`	`getJobComplete()` Whether the query has completed or not.
`JobReference`	`getJobReference()` Reference to the BigQuery Job that was created to run the query.
`String`	`getKind()` The resource type of the response.
`Long`	`getNumDmlAffectedRows()` Output only.
`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.
`GetQueryResultsResponse`	`set(String fieldName, Object value)`
`GetQueryResultsResponse`	`setCacheHit(Boolean cacheHit)` Whether the query result was fetched from the query cache.
`GetQueryResultsResponse`	`setErrors(List<ErrorProto> errors)` Output only.
`GetQueryResultsResponse`	`setEtag(String etag)` A hash of this response.
`GetQueryResultsResponse`	`setJobComplete(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(String kind)` The resource type of the response.
`GetQueryResultsResponse`	`setNumDmlAffectedRows(Long numDmlAffectedRows)` Output only.
`GetQueryResultsResponse`	`setPageToken(String pageToken)` A token used for paging results.
`GetQueryResultsResponse`	`setRows(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(Long totalBytesProcessed)` The total number of bytes processed for this query.
`GetQueryResultsResponse`	`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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
  - GetQueryResultsResponse
```
public GetQueryResultsResponse()
```
- Method Detail
  - getCacheHit
```
public Boolean getCacheHit()
```
    Whether the query result was fetched from the query cache.
    
    Returns:
    
    value or null for none
  - setCacheHit
```
public GetQueryResultsResponse 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. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).
    
    Returns:
    
    value or null for none
  - setErrors
```
public GetQueryResultsResponse 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. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).
    
    Parameters:
    
    errors - errors or null for none
  - getEtag
```
public String getEtag()
```
    A hash of this response.
    
    Returns:
    
    value or null for none
  - setEtag
```
public GetQueryResultsResponse setEtag(String etag)
```
    A hash of this response.
    
    Parameters:
    
    etag - etag 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 GetQueryResultsResponse 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 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 String getKind()
```
    The resource type of the response.
    
    Returns:
    
    value or null for none
  - setKind
```
public GetQueryResultsResponse setKind(String kind)
```
    The resource type of the response.
    
    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 GetQueryResultsResponse 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. When this token is non-empty, it indicates additional results are available.
    
    Returns:
    
    value or null for none
  - setPageToken
```
public GetQueryResultsResponse setPageToken(String pageToken)
```
    A token used for paging results. When this token is non-empty, it indicates additional results are available.
    
    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. Present only when the query completes successfully. The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values.
    
    Returns:
    
    value or null for none
  - setRows
```
public GetQueryResultsResponse 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. Present only when the query completes successfully. The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values.
    
    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 Long getTotalBytesProcessed()
```
    The total number of bytes processed for this query.
    
    Returns:
    
    value or null for none
  - setTotalBytesProcessed
```
public GetQueryResultsResponse setTotalBytesProcessed(Long totalBytesProcessed)
```
    The total number of bytes processed for this query.
    
    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. Present only when the query completes successfully.
    
    Returns:
    
    value or null for none
  - setTotalRows
```
public GetQueryResultsResponse 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. Present only when the query completes successfully.
    
    Parameters:
    
    totalRows - totalRows or null for none
  - set
```
public GetQueryResultsResponse set(String fieldName,
                                   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

Class GetQueryResultsResponse

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GetQueryResultsResponse

Method Detail

getCacheHit

setCacheHit

getErrors

setErrors

getEtag

setEtag

getJobComplete

setJobComplete

getJobReference

setJobReference

getKind

setKind

getNumDmlAffectedRows

setNumDmlAffectedRows

getPageToken

setPageToken

getRows

setRows

getSchema

setSchema

getTotalBytesProcessed

setTotalBytesProcessed

getTotalRows

setTotalRows

set

clone