target.apidocs.com.google.api.services.bigquery.Bigquery.Jobs.GetQueryResults.html Maven / Gradle / Ivy
Bigquery.Jobs.GetQueryResults (BigQuery API v2-rev20190423-1.28.0)
com.google.api.services.bigquery
Class Bigquery.Jobs.GetQueryResults
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.bigquery.BigqueryRequest<GetQueryResultsResponse>
-
- com.google.api.services.bigquery.Bigquery.Jobs.GetQueryResults
-
- Enclosing class:
- Bigquery.Jobs
public class Bigquery.Jobs.GetQueryResults
extends BigqueryRequest<GetQueryResultsResponse>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
GetQueryResults(String projectId,
String jobId)
Retrieves the results of a query job.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getJobId()
[ Required] Job ID of the query job
[
String
getLocation()
The geographic location where the job should run.
Long
getMaxResults()
Maximum number of results to read
String
getPageToken()
Page token, returned by a previous call, to request the next page of results
String
getProjectId()
[ Required] Project ID of the query job
[
BigInteger
getStartIndex()
Zero-based index of the starting row
Long
getTimeoutMs()
How long to wait for the query to complete, in milliseconds, before returning.
Bigquery.Jobs.GetQueryResults
set(String parameterName,
Object value)
Bigquery.Jobs.GetQueryResults
setAlt(String alt)
Data format for the response.
Bigquery.Jobs.GetQueryResults
setFields(String fields)
Selector specifying which fields to include in a partial response.
Bigquery.Jobs.GetQueryResults
setJobId(String jobId)
[Required] Job ID of the query job
Bigquery.Jobs.GetQueryResults
setKey(String key)
API key.
Bigquery.Jobs.GetQueryResults
setLocation(String location)
The geographic location where the job should run.
Bigquery.Jobs.GetQueryResults
setMaxResults(Long maxResults)
Maximum number of results to read
Bigquery.Jobs.GetQueryResults
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Bigquery.Jobs.GetQueryResults
setPageToken(String pageToken)
Page token, returned by a previous call, to request the next page of results
Bigquery.Jobs.GetQueryResults
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Bigquery.Jobs.GetQueryResults
setProjectId(String projectId)
[Required] Project ID of the query job
Bigquery.Jobs.GetQueryResults
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Bigquery.Jobs.GetQueryResults
setStartIndex(BigInteger startIndex)
Zero-based index of the starting row
Bigquery.Jobs.GetQueryResults
setTimeoutMs(Long timeoutMs)
How long to wait for the query to complete, in milliseconds, before returning.
Bigquery.Jobs.GetQueryResults
setUserIp(String userIp)
Deprecated.
-
Methods inherited from class com.google.api.services.bigquery.BigqueryRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
-
GetQueryResults
protected GetQueryResults(String projectId,
String jobId)
Retrieves the results of a query job.
Create a request for the method "jobs.getQueryResults".
This request holds the parameters needed by the the bigquery server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote
operation. GetQueryResults#initialize(com.google.api.client.googleapis.services.Abst
ractGoogleClientRequest)
must be called to initialize this instance immediately after invoking
the constructor.
- Parameters:
projectId
- [Required] Project ID of the query job
jobId
- [Required] Job ID of the query job
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetQueryResultsResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetQueryResultsResponse>
- Throws:
IOException
-
setAlt
public Bigquery.Jobs.GetQueryResults setAlt(String alt)
Description copied from class: BigqueryRequest
Data format for the response.
- Overrides:
setAlt
in class BigqueryRequest<GetQueryResultsResponse>
-
setFields
public Bigquery.Jobs.GetQueryResults setFields(String fields)
Description copied from class: BigqueryRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class BigqueryRequest<GetQueryResultsResponse>
-
setKey
public Bigquery.Jobs.GetQueryResults setKey(String key)
Description copied from class: BigqueryRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey
in class BigqueryRequest<GetQueryResultsResponse>
-
setOauthToken
public Bigquery.Jobs.GetQueryResults setOauthToken(String oauthToken)
Description copied from class: BigqueryRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class BigqueryRequest<GetQueryResultsResponse>
-
setPrettyPrint
public Bigquery.Jobs.GetQueryResults setPrettyPrint(Boolean prettyPrint)
Description copied from class: BigqueryRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class BigqueryRequest<GetQueryResultsResponse>
-
setQuotaUser
public Bigquery.Jobs.GetQueryResults setQuotaUser(String quotaUser)
Description copied from class: BigqueryRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- Overrides:
setQuotaUser
in class BigqueryRequest<GetQueryResultsResponse>
-
setUserIp
public Bigquery.Jobs.GetQueryResults setUserIp(String userIp)
Description copied from class: BigqueryRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class BigqueryRequest<GetQueryResultsResponse>
-
getProjectId
public String getProjectId()
[ Required] Project ID of the query job
[
-
setProjectId
public Bigquery.Jobs.GetQueryResults setProjectId(String projectId)
[Required] Project ID of the query job
-
getJobId
public String getJobId()
[ Required] Job ID of the query job
[
-
setJobId
public Bigquery.Jobs.GetQueryResults setJobId(String jobId)
[Required] Job ID of the query job
-
getLocation
public String getLocation()
The geographic location where the job should run. Required except for US and EU. See details at
https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
-
setLocation
public Bigquery.Jobs.GetQueryResults setLocation(String location)
The geographic location where the job should run. Required except for US and EU. See
details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
-
getMaxResults
public Long getMaxResults()
Maximum number of results to read
-
setMaxResults
public Bigquery.Jobs.GetQueryResults setMaxResults(Long maxResults)
Maximum number of results to read
-
getPageToken
public String getPageToken()
Page token, returned by a previous call, to request the next page of results
-
setPageToken
public Bigquery.Jobs.GetQueryResults setPageToken(String pageToken)
Page token, returned by a previous call, to request the next page of results
-
getStartIndex
public BigInteger getStartIndex()
Zero-based index of the starting row
-
setStartIndex
public Bigquery.Jobs.GetQueryResults setStartIndex(BigInteger startIndex)
Zero-based index of the starting row
-
getTimeoutMs
public Long getTimeoutMs()
How long to wait for the query to complete, in milliseconds, before returning. Default is 10
seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response
will be false
-
setTimeoutMs
public Bigquery.Jobs.GetQueryResults setTimeoutMs(Long timeoutMs)
How long to wait for the query to complete, in milliseconds, before returning. Default is
10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the
response will be false
-
set
public Bigquery.Jobs.GetQueryResults set(String parameterName,
Object value)
- Overrides:
set
in class BigqueryRequest<GetQueryResultsResponse>
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy