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

Constructors
Constructor and Description
`QueryResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryResponse`	`clone()`
`Boolean`	`getCacheHit()` Whether the query result was fetched from the query cache.
`Long`	`getCreationTime()` Output only.
`DmlStatistics`	`getDmlStats()` Output only.
`Long`	`getEndTime()` Output only.
`List<ErrorProto>`	`getErrors()` Output only.
`Boolean`	`getJobComplete()` Whether the query has completed or not.
`JobCreationReason`	`getJobCreationReason()` Optional.
`JobReference`	`getJobReference()` Reference to the Job that was created to run the query.
`String`	`getKind()` The resource type.
`String`	`getLocation()` Output only.
`Long`	`getNumDmlAffectedRows()` Output only.
`String`	`getPageToken()` A token used for paging results.
`String`	`getQueryId()` Auto-generated ID for the query.
`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.
`SessionInfo`	`getSessionInfo()` Output only.
`Long`	`getStartTime()` Output only.
`Long`	`getTotalBytesBilled()` Output only.
`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.
`Long`	`getTotalSlotMs()` Output only.
`QueryResponse`	`set(String fieldName, Object value)`
`QueryResponse`	`setCacheHit(Boolean cacheHit)` Whether the query result was fetched from the query cache.
`QueryResponse`	`setCreationTime(Long creationTime)` Output only.
`QueryResponse`	`setDmlStats(DmlStatistics dmlStats)` Output only.
`QueryResponse`	`setEndTime(Long endTime)` Output only.
`QueryResponse`	`setErrors(List<ErrorProto> errors)` Output only.
`QueryResponse`	`setJobComplete(Boolean jobComplete)` Whether the query has completed or not.
`QueryResponse`	`setJobCreationReason(JobCreationReason jobCreationReason)` Optional.
`QueryResponse`	`setJobReference(JobReference jobReference)` Reference to the Job that was created to run the query.
`QueryResponse`	`setKind(String kind)` The resource type.
`QueryResponse`	`setLocation(String location)` Output only.
`QueryResponse`	`setNumDmlAffectedRows(Long numDmlAffectedRows)` Output only.
`QueryResponse`	`setPageToken(String pageToken)` A token used for paging results.
`QueryResponse`	`setQueryId(String queryId)` Auto-generated ID for the query.
`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`	`setSessionInfo(SessionInfo sessionInfo)` Output only.
`QueryResponse`	`setStartTime(Long startTime)` Output only.
`QueryResponse`	`setTotalBytesBilled(Long totalBytesBilled)` Output only.
`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.
`QueryResponse`	`setTotalSlotMs(Long totalSlotMs)` Output only.

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
  - 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
  - getCreationTime
```
public Long getCreationTime()
```
    Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public QueryResponse setCreationTime(Long creationTime)
```
    Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getDmlStats
```
public DmlStatistics getDmlStats()
```
    Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
    
    Returns:
    
    value or null for none
  - setDmlStats
```
public QueryResponse setDmlStats(DmlStatistics dmlStats)
```
    Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
    
    Parameters:
    
    dmlStats - dmlStats or null for none
  - getEndTime
```
public Long getEndTime()
```
    Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public QueryResponse setEndTime(Long endTime)
```
    Output only. End time of this query, in milliseconds since the epoch. This field will be present whenever a query job is in the DONE state.
    
    Parameters:
    
    endTime - endTime 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 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. For more information about error messages, see [Error messages](https://cloud.google.com/bigquery/docs/error-messages).
    
    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
  - getJobCreationReason
```
public JobCreationReason getJobCreationReason()
```
    Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset.
    
    Returns:
    
    value or null for none
  - setJobCreationReason
```
public QueryResponse setJobCreationReason(JobCreationReason jobCreationReason)
```
    Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset.
    
    Parameters:
    
    jobCreationReason - jobCreationReason 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). If job_creation_mode was set to `JOB_CREATION_OPTIONAL` and the query completes without creating a job, this field will be empty.
    
    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). If job_creation_mode was set to `JOB_CREATION_OPTIONAL` and the query completes without creating a job, this field will be empty.
    
    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
  - getLocation
```
public String getLocation()
```
    Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations
    
    Returns:
    
    value or null for none
  - setLocation
```
public QueryResponse setLocation(String location)
```
    Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations
    
    Parameters:
    
    location - location 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. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.c om/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).
    
    Returns:
    
    value or null for none
  - setPageToken
```
public QueryResponse setPageToken(String pageToken)
```
    A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.c om/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).
    
    Parameters:
    
    pageToken - pageToken or null for none
  - getQueryId
```
public String getQueryId()
```
    Auto-generated ID for the query.
    
    Returns:
    
    value or null for none
  - setQueryId
```
public QueryResponse setQueryId(String queryId)
```
    Auto-generated ID for the query.
    
    Parameters:
    
    queryId - queryId 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
  - getSessionInfo
```
public SessionInfo getSessionInfo()
```
    Output only. Information of the session if this job is part of one.
    
    Returns:
    
    value or null for none
  - setSessionInfo
```
public QueryResponse setSessionInfo(SessionInfo sessionInfo)
```
    Output only. Information of the session if this job is part of one.
    
    Parameters:
    
    sessionInfo - sessionInfo or null for none
  - getStartTime
```
public Long getStartTime()
```
    Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public QueryResponse setStartTime(Long startTime)
```
    Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE.
    
    Parameters:
    
    startTime - startTime or null for none
  - getTotalBytesBilled
```
public Long getTotalBytesBilled()
```
    Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.
    
    Returns:
    
    value or null for none
  - setTotalBytesBilled
```
public QueryResponse setTotalBytesBilled(Long totalBytesBilled)
```
    Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only.
    
    Parameters:
    
    totalBytesBilled - totalBytesBilled 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
  - getTotalSlotMs
```
public Long getTotalSlotMs()
```
    Output only. Number of slot ms the user is actually billed for.
    
    Returns:
    
    value or null for none
  - setTotalSlotMs
```
public QueryResponse setTotalSlotMs(Long totalSlotMs)
```
    Output only. Number of slot ms the user is actually billed for.
    
    Parameters:
    
    totalSlotMs - totalSlotMs 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

Class QueryResponse

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

QueryResponse

Method Detail

getCacheHit

setCacheHit

getCreationTime

setCreationTime

getDmlStats

setDmlStats

getEndTime

setEndTime

getErrors

setErrors

getJobComplete

setJobComplete

getJobCreationReason

setJobCreationReason

getJobReference

setJobReference

getKind

setKind

getLocation

setLocation

getNumDmlAffectedRows

setNumDmlAffectedRows

getPageToken

setPageToken

getQueryId

setQueryId

getRows

setRows

getSchema

setSchema

getSessionInfo

setSessionInfo

getStartTime

setStartTime

getTotalBytesBilled

setTotalBytesBilled

getTotalBytesProcessed

setTotalBytesProcessed

getTotalRows

setTotalRows

getTotalSlotMs

setTotalSlotMs

set

clone